Ever wanted to know EXACTLY what Ranking signals Google uses? Here is a searchable list. These variables were found on a server under Apache 2.0 license and shared (publicly) by Mike King from iPullRank. He got them via Rand, who got them from an anonymous person, who found them under the Apache 2.0 license. They represent all the ranking signals that we believe Googlers might have access to for their algorithms. I put them here as an easy way for me (and others) to search for buzzwords like “PageRank” and “mustang”. If you want to know, I run an SEO SAAS called InLinks.
Update 29 May: I just changed the column order. I think it makes more sense. Clicking on any row shows the row in a modal.
(Takes a minute to load… 14,000 rows. Wait until you see the search box.)
Signals searchable below… use the green (+) icon to expand.
| Name | Description | ModuleName | ModuleDescription | Type |
|---|---|---|---|---|
| id | AbuseiamAbuseType | String | ||
| subtype | 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. | AbuseiamAbuseType | String | |
| ageYears | This restriction applies if the user is between [min_age_years, age_years) years old. | AbuseiamAgeRestriction | integer | |
| minAgeYears | AbuseiamAgeRestriction | integer | ||
| child | This restriction applies if all of the children apply. | AbuseiamAndRestriction | list(AbuseiamUserRestriction) | |
| id | AbuseiamClient | A client is be a Google product, or subproduct that provides content for AbuseIAm to classify. | String | |
| subservice | The name of the subservice within a client. This subservice can be used to affect the flow of decision script, or selection of backend classifiers. For example, StreetView may want to specify a panel is insufficiently blurred (maybe there is a lisense plate or public sex, etc), which requires manual review then the subservice might be “blurring”. | AbuseiamClient | A client is be a Google product, or subproduct that provides content for AbuseIAm to classify. | String |
| type | A constant of type TRUE always applies, and of type FALSE never applies. | AbuseiamConstantRestriction | String | |
| adminVerdict | Takedowns specified by admins via AbuseIAm | AbuseiamContentRestriction | Pair of Verdicts used for ProjectR age/geo gating. See http://go/projectr for more information. | list(AbuseiamVerdict) |
| userVerdict | User-specified takedowns | AbuseiamContentRestriction | Pair of Verdicts used for ProjectR age/geo gating. See http://go/projectr for more information. | list(AbuseiamVerdict) |
| abuseType | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | AbuseiamAbuseType | |
| backend | Who creates this Evaluation. This field is required. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String |
| comment | Backends can choose to put some debug info in addition to abuse_type, score, and status. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String |
| miscData | This field is used to store miscellaneous information that Backend might provide. If you find youself here considering to use this field, please prefer using the repeated feature field below instead. It supports a richer structure for passing complex data back from the backend. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | list(AbuseiamNameValuePair) |
| processedMicros | When the evaluation was processed by the decision script. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String |
| region | The list of regions where the evaluation applies. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | list(AbuseiamRegion) |
| score | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | float | |
| status | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String | |
| target | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | AbuseiamTarget | |
| timestampMicros | When the Evaluation was generated. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String |
| userRestriction | A boolean expression tree used to define the restrictions where the verdict applies. Please use java/com/google/ccc/abuse/abuseiam/client/TakedownManager.java to evaluate this proto. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | AbuseiamUserRestriction |
| version | Version of Backend. For rules, this string is the only way to differentiate between them. | AbuseiamEvaluation | Backends return Evaluations to AbuseIAm. One of the things Evaluations are used for is to explain Verdicts. | String |
| locale | 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. | list(AbuseiamGeoRestrictionLocale) | |
| location | The location where the restriction applies. Defaults to the “The world”. See go/iii. | AbuseiamGeoRestrictionLocale | String | |
| restriction | The UserRestriction that applies to this location. If not specified evaluates to true. | AbuseiamGeoRestrictionLocale | AbuseiamUserRestriction | |
| hash | 64 bit hash in the hex form. | AbuseiamHash | Information about various hashes that can be computed on a message ex: simhash, attachment hash, etc | String |
| type | AbuseiamHash | Information about various hashes that can be computed on a message ex: simhash, attachment hash, etc | String | |
| name | AbuseiamNameValuePair | String | ||
| nonUtf8Value | AbuseiamNameValuePair | String | ||
| value | AbuseiamNameValuePair | String | ||
| child | This restriction applies if the child does not apply. Only one is allowed. “repeated” is used to avoid breaking Sawzall (See b/6758277). | AbuseiamNotRestriction | list(AbuseiamUserRestriction) | |
| child | This restriction applies if any of the children apply. | AbuseiamOrRestriction | list(AbuseiamUserRestriction) | |
| region | This is a CLDR Region Code: http://wiki/Main/IIIHowTo#using_region It is used to denote the region affected by a verdict. | AbuseiamRegion | String | |
| type | AbuseiamSpecialRestriction | A SpecialRestriction is a standardized UserRestriction which lives in a table maintained via CDD. | String | |
| id | AbuseiamTarget | String | ||
| type | AbuseiamTarget | String | ||
| channel | AbuseiamUserNotification | A structure used to configure a notification to a user. | String | |
| ageRestriction | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamAgeRestriction | |
| andRestriction | Operators | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamAndRestriction |
| constantRestriction | Constant | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamConstantRestriction |
| geoRestriction | Leaf Nodes | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamGeoRestriction |
| notRestriction | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamNotRestriction | |
| orRestriction | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamOrRestriction | |
| specialRestriction | AbuseiamUserRestriction | Describes restrictions on where the verdict applies. Please use {@code TakedownManager} to evaluate this proto. | AbuseiamSpecialRestriction | |
| client | Target client of the verdict. It can be used to differentiate verdicts from multiple clients when such verdicts are processed in one common place. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | AbuseiamClient |
| comment | Additional info regarding the verdict. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| decision | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String | |
| durationMins | Time duration (in minutes) of the verdict. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | integer |
| evaluation | Evaluations relevant to this verdict. Every Verdict should contain at least one Evaluation. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamEvaluation) |
| hashes | Details of all the hashes that can be computed on a message, such as simhash and attachment hash | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamHash) |
| isLegalIssued | Is this verdict issued by legal? | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | boolean |
| miscScores | This field is used to pass relevant / necessary scores to our clients. For eg: ASBE propagates these scores to moonshine. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamNameValuePair) |
| reasonCode | A short description of the reason why the verdict decision is made. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| region | The regions in which this verdict should be enforced. Absence of this field indicates that the verdict is applicable everywhere. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamRegion) |
| restriction | Restrictions on where this verdict applies. If any restriction is met, the verdict is applied there. If no restrictions are present, the verdict is considered global. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamVerdictRestriction) |
| strikeCategory | Category of the strike if this is a strike verdict. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| target | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | AbuseiamTarget | |
| targetTimestampMicros | The timestamp of the target. E.g., the time when the target was updated. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| timestampMicros | When the verdict is generated | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| userNotification | Extra notification(s) to be delivered to target user or message owner about the verdict. | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | list(AbuseiamUserNotification) |
| version | version of decision script | AbuseiamVerdict | Verdict against a target. AbuseIAm generates a verdict based on evaluations. AbuseIAm can send such verdicts to clients for enforcement. | String |
| context | For a restriction to apply, all contexts must be satisfied. For example, if context[0] is COUNTRY/’GERMANY’ and context[1] is DESTINATION_STREAM/’gplus:SQUARE:knitting_discussion’, then the verdict applies only when the ‘knitting discussion’ square is viewed from inside Germany. Please note that this is present for legacy reasons and users of this field would be migrated to use the user_restriction field defined below. | AbuseiamVerdictRestriction | Describes restrictions on where the verdict applies. | list(AbuseiamVerdictRestrictionContext) |
| userRestriction | A boolean expression tree used to define the restrictions where the verdict applies. Please use java/com/google/ccc/abuse/abuseiam/client/TakedownManager.java to evaluate this proto. | AbuseiamVerdictRestriction | Describes restrictions on where the verdict applies. | AbuseiamUserRestriction |
| id | String identifying the context. | AbuseiamVerdictRestrictionContext | Describes a dimension of a context where a verdict applies. | String |
| type | AbuseiamVerdictRestrictionContext | Describes a dimension of a context where a verdict applies. | String | |
| highId | 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. | String | |
| lowId1 | 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. | String | |
| lowId2 | 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. | String | |
| anchor | Anchors | list(AnchorsAnchor) | ||
| homepageAnchorsDropped | The total # of local homepage anchors dropped in AnchorAccumulator. | Anchors | String | |
| indexTier | 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. | Anchors | integer | |
| localAnchorsDropped | The total # of local non-homepage anchors dropped in AnchorAccumulator. | Anchors | String | |
| nonlocalAnchorsDropped | The total # of non-local anchors dropped in AnchorAccumulator. | Anchors | String | |
| redundantAnchorsDropped | The *_anchors_dropped fields below are not populated by Alexandria, which uses cdoc.anchor_stats instead. The total # of redundant anchors dropped in linkextractor. | Anchors | String | |
| redundantanchorinfo | Anchors | list(AnchorsRedundantAnchorInfo) | ||
| supplementalAnchorsDropped | The total # of supplemental anchors dropped in AnchorAccumulator. ## DEPRECATED. | Anchors | String | |
| targetDocid | may be implicit | Anchors | String | |
| targetSite | HOST_LEVEL site chunking. | Anchors | String | |
| targetUrl | This is produced during link extraction but not written out in the linklogs in order to save space. | Anchors | String | |
| creationDate | 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. | AnchorsAnchor | integer | |
| origText | Original text, including capitalization and punctuation. Runs of whitespace are collapsed into a single space. | AnchorsAnchor | String | |
| context2 | This is a hash of terms near the anchor. (This is a second-generation hash replacing the value stored in the ‘context’ field.) | AnchorsAnchor | integer | |
| fontsize | AnchorsAnchor | integer | ||
| experimental | If true, the anchor is for experimental purposes and should not be used in serving. | AnchorsAnchor | boolean | |
| fragment | The URL fragment for this anchor (the foo in http://www.google.com#foo) | AnchorsAnchor | String | |
| sourceType | 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. | AnchorsAnchor | integer | |
| pagerankWeight | Weight to be stored in linkmaps for pageranker | AnchorsAnchor | number | |
| isLocal | 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). | AnchorsAnchor | boolean | |
| originalTargetDocid | The docid of the anchor’s original target. This field is available if and only if the anchor is forwarded. | AnchorsAnchor | String | |
| fullLeftContext | The full context. These are not written out in the linklogs. | AnchorsAnchor | list(String) | |
| expired | true iff exp domain | AnchorsAnchor | boolean | |
| catfishTags | 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/indexing | AnchorsAnchor | list(integer) | |
| deletionDate | AnchorsAnchor | integer | ||
| linkTags | Contains info on link type, source page, etc. | AnchorsAnchor | list(integer) | |
| forwardingTypes | 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. | AnchorsAnchor | integer | |
| possiblyOldFirstseenDate | 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. | AnchorsAnchor | boolean | |
| locality | For ranking purposes, the quality of an anchor is measured by its “locality” and “bucket”. See quality/anchors/definitions.h for more information. | AnchorsAnchor | integer | |
| demotionreason | DEPRECATED | AnchorsAnchor | integer | |
| parallelLinks | The number of additional links from the same source page to the same target domain. Not populated if is_local is true. | AnchorsAnchor | integer | |
| text | 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 . | AnchorsAnchor | String | |
| source | AnchorsAnchor | AnchorsAnchorSource | ||
| bucket | AnchorsAnchor | integer | ||
| fullRightContext | AnchorsAnchor | list(String) | ||
| targetUrlEncoding | 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. | AnchorsAnchor | integer | |
| compressedOriginalTargetUrl | The anchor’s original target url, compressed. Available only in Alexandria docjoins when the anchor is forwarded. | AnchorsAnchor | String | |
| firstseenDate | # 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 extraction | AnchorsAnchor | integer | |
| setiPagerankWeight | TEMPORARY | AnchorsAnchor | number | |
| context | AnchorsAnchor | integer | ||
| linkAdditionalInfo | Additional information related to the anchor, such as additional anchor text or scores. | AnchorsAnchor | Proto2BridgeMessageSet | |
| type | DEPRECATED: Now in link_tags | AnchorsAnchor | integer | |
| firstseenNearCreation | 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. | AnchorsAnchor | boolean | |
| lastUpdateTimestamp | Used for history and freshness tracking – the timestamp this anchor is updated in indexing. | AnchorsAnchor | integer | |
| offset | 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. | AnchorsAnchor | integer | |
| weight | weights are 0-127 | AnchorsAnchor | integer | |
| deleted | AnchorsAnchor | boolean | ||
| encodedNewsAnchorData | 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. | AnchorsAnchor | integer | |
| compressedImageUrls | If the anchor contained images, these image urls are stored here in compressed form. | AnchorsAnchor | list(String) | |
| timestamp | This field is DEPRECATED and no longer filled. For source page crawl timestamp, use Source.crawl_timestamp. Next tag id should be 62. | AnchorsAnchor | String | |
| additionalInfo | Additional information related to the source, such as news hub info. | AnchorsAnchorSource | attributes of the source document for the link | Proto2BridgeMessageSet |
| cluster | anchor++ cluster id | AnchorsAnchorSource | attributes of the source document for the link | integer |
| compressedUrl | compressed source url | AnchorsAnchorSource | attributes of the source document for the link | String |
| crawlTimestamp | Source page crawl timestamp. | AnchorsAnchorSource | attributes of the source document for the link | String |
| docid | The docid field used to be “required”, but it is now “optional” because it is not present when anchors are stored in webtable. When anchors are stored as part of docjoin files in the segment indexer, however, docid should be considered required. | AnchorsAnchorSource | attributes of the source document for the link | String |
| doclength | necessary for anything? | AnchorsAnchorSource | attributes of the source document for the link | integer |
| homePageInfo | Information about if the source page is a home page. It can be one of the enum values defined in PerDocData::HomePageInfo (NOT_HOMEPAGE, NOT_TRUSTED, PARTIALLY_TRUSTED, and FULLY_TRUSTED). | AnchorsAnchorSource | attributes of the source document for the link | integer |
| indyrank | uint16 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| ipaddr | DEPRECATED, use packed_ipaddress | AnchorsAnchorSource | attributes of the source document for the link | integer |
| language | default -> English | AnchorsAnchorSource | attributes of the source document for the link | integer |
| linkhash | 0 -> no hash | AnchorsAnchorSource | attributes of the source document for the link | String |
| localCountryCodes | Countries to which the source page is local/most relevant; stored as III identifiers for country/region codes (see http://go/iii). | AnchorsAnchorSource | attributes of the source document for the link | list(integer) |
| nsr | This NSR value has range [0,1000] and is the original value [0.0,1.0] multiplied by 1000 rounded to an integer. | AnchorsAnchorSource | attributes of the source document for the link | integer |
| outdegree | AnchorsAnchorSource | attributes of the source document for the link | integer | |
| outsites | approx num of pointed-to sites | AnchorsAnchorSource | attributes of the source document for the link | integer |
| packedIpaddress | string in IPAddress::ToPackedString() format. | AnchorsAnchorSource | attributes of the source document for the link | String |
| pageTags | Page tags are described by enum PageTag in PerDocData. Page tags are used in anchors to identify properties of the linking page. These are DEPRECATED: in the future, use link_tags instead. DEPRECATED | AnchorsAnchorSource | attributes of the source document for the link | list(integer) |
| pagerank | uint16 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| pagerankNs | unit16 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| seglanguage | DEPRECATED | AnchorsAnchorSource | attributes of the source document for the link | integer |
| site | AnchorsAnchorSource | attributes of the source document for the link | String | |
| spamrank | uint16 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| spamscore1 | deprecated, to be removed after October 20. 0-127 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| spamscore2 | 0-127 scale | AnchorsAnchorSource | attributes of the source document for the link | integer |
| webtableKey | Webtable key of source | AnchorsAnchorSource | attributes of the source document for the link | String |
| anchorsDropped | 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. | String | |
| domain | 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. | String | |
| text | 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. | String | |
| customerId | AppsDynamiteCustomerId | Represents a GSuite customer ID. Obfuscated with CustomerIdObfuscator. | String | |
| consumerInfo | AppsDynamiteSharedOrganizationInfo | Contains info about the entity that something is, or is owned by. | AppsDynamiteSharedOrganizationInfoConsumerInfo | |
| customerInfo | AppsDynamiteSharedOrganizationInfo | Contains info about the entity that something is, or is owned by. | AppsDynamiteSharedOrganizationInfoCustomerInfo | |
| customerId | AppsDynamiteSharedOrganizationInfoCustomerInfo | AppsDynamiteCustomerId | ||
| memberType | AppsDynamiteSharedSegmentedMembershipCount | Contains info on membership count for member types: HUMAN_USER, APP_USER & ROSTER_MEMBER different states: INVITED, JOINED | String | |
| membershipCount | count of members with given type and state | AppsDynamiteSharedSegmentedMembershipCount | Contains info on membership count for member types: HUMAN_USER, APP_USER & ROSTER_MEMBER different states: INVITED, JOINED | integer |
| membershipState | AppsDynamiteSharedSegmentedMembershipCount | Contains info on membership count for member types: HUMAN_USER, APP_USER & ROSTER_MEMBER different states: INVITED, JOINED | String | |
| value | AppsDynamiteSharedSegmentedMembershipCounts | list(AppsDynamiteSharedSegmentedMembershipCount) | ||
| id | The hierarchy of IDs. Each individual ID is “flat” and the repeated list defines the hierarchy. Namespaces define the “validity” of this hierachy (depth, naming convention, etc) and the server will reject invalid IDs. | 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 | list(String) |
| namespace | 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 | String | |
| reportCompromised | Corresponds on “This account might be compromised or hacked” reporting action. | 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. | String |
| reportHarassment | Corresponds on “Harassment or bullying” reporting action. | 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. | String |
| reportHate | Corresponds on “Hate speach or graphic violence” reporting action. | 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. | String |
| reportPorn | Corresponds on “Pornography or sexually explicit material” reporting action. | 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. | String |
| reportSpam | Corresponds on “Unwanted commercial content or spam” reporting action. | 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. | String |
| serveCount | Number of times this activity was served out of asbe/stanza. | 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. | String |
| timeSec | Timestamp in seconds for which time this record is valid. | 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. | String |
| ytThumbsDown | Corresponds on Distiller comment thumbs down action. | 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. | String |
| contentType | AppsPeopleOzExternalMergedpeopleapiAbout | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiAbout | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| safeHtmlValue | Sanitized HTML value that is only populated when the SANITIZE_ABOUT_HTML extension is requested. | AppsPeopleOzExternalMergedpeopleapiAbout | WebutilHtmlTypesSafeHtmlProto | |
| value | AppsPeopleOzExternalMergedpeopleapiAbout | String | ||
| nameDisplayOptions | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedData | Extension data for use in AboutMe. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataNameDisplayOptions | |
| photosCompareData | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedData | Extension data for use in AboutMe. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | |
| profileEditability | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedData | Extension data for use in AboutMe. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileEditability | |
| profileNameModificationHistory | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedData | Extension data for use in AboutMe. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | |
| nicknameOption | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataNameDisplayOptions | See NameDisplayOptions in //depot/google3/focus/backend/proto/backend.proto. See also go/nickname-mess. | String | |
| diffData | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareDataDiffData | ||
| highResUrl | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | String | ||
| inconsistentPhoto | 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-photos | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | boolean | |
| lowResData | Only present if the photo diff is greater than 0.01 on any color band. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | String | |
| lowResUrl | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | String | ||
| monogramUrl | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | String | ||
| privateLowResAcl | True if the low-res photo has a private ACL set. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareData | boolean | |
| blueDiff | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareDataDiffData | number | ||
| greenDiff | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareDataDiffData | number | ||
| redDiff | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataPhotosCompareDataDiffData | number | ||
| lockedField | Read-only set of zero or more field paths that are locked for update on this person, such as “person.name”, “person.email”, etc. The set of fields is only populated for the requester’s profile. Fields in the set cannot be edited, added, or deleted from the profile. Attempting to update any of these fields will result in an exception. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileEditability | See UserEditedLockedMask in //depot/google3/focus/backend/proto/backend.proto. | list(String) |
| computedNameChangesRemaining | The number of name changes remaining at RPC request time. This can be more than name_changes_remaining, if user hasn’t changed name for some time and accrued quota since last change. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | integer |
| computedNicknameChangesRemaining | The number of nickname changes remaining at RPC request time. This can be more than nickname_changes_remaining, if user hasn’t changed nickname for some time and accrued quota since last change. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | integer |
| nameChangesRemaining | The number of name changes remaining at the time the name was last modified. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | integer |
| nameLastModified | The last time the profile name was modified in milliseconds UTC. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | String |
| nicknameChangesRemaining | The number of nickname changes remaining at the time the nickname was last modified. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | integer |
| nicknameLastModified | The last time the profile nickname was modified in milliseconds UTC. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | String |
| quotaEnforcementStatus | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedDataProfileNameModificationHistory | See ABUSE_NAME_LAST_MODIFIED in //depot/google3/focus/backend/proto/backend.proto which maps to //depot/google3/focus/proto/profileattribute.proto | String | |
| AppsPeopleOzExternalMergedpeopleapiAccountEmail | String | |||
| rawDeviceContactInfo | When the container is a DEVICE_CONTACT, this list provides account information from the raw contact which is the source of this field. | AppsPeopleOzExternalMergedpeopleapiAdditionalContainerInfo | Additional information about a container. TO BE DELETED: replaced by DeviceContactInfo. | list(AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo) |
| country | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| countryCode | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| encodedPlaceId | FeatureId associated with the address. The format is the same as that used for ids in PLACE containers in SourceIdentity. | AppsPeopleOzExternalMergedpeopleapiAddress | String | |
| extendedAddress | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| formatted | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiAddress | String | |
| locality | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiAddress | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| poBox | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| pointSpec | AppsPeopleOzExternalMergedpeopleapiAddress | AppsPeopleOzExternalMergedpeopleapiPointSpec | ||
| postalCode | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| region | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| streetAddress | AppsPeopleOzExternalMergedpeopleapiAddress | String | ||
| type | The type of the address. The type can be free form or one of these predefined values: * `home` * `work` * `other` | AppsPeopleOzExternalMergedpeopleapiAddress | String | |
| affinityMetadata | Contains extra ranking information returned by DAS. | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | SocialGraphWireProtoPeopleapiAffinityMetadata |
| affinityType | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | String | |
| containerId | The ID of the container | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | String |
| containerType | The type of container to which this affinity applies | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | String |
| loggingId | Used to log events for this affinity value, for disco diagnostic-purposes. See go/disco-diagnostics. | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | String |
| value | Affinity value. Frequently represented as an inverse ranking, sometimes with additional data encoded. If data_formats.affinity_formats.score_format is set to RAW_SCORE then the value will be the score returned by DAS. | AppsPeopleOzExternalMergedpeopleapiAffinity | Similar to social.graph.storage.Affinity, but pared down to what the clients of the People API are interested in. | float |
| ageInYears | Please read go/people-api-howto:age on how to get age data. Age of the user. The field is set based on profile storage fields such as account birthday. If the source fields are not present, `age_in_years` will be left unset. | 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. | integer |
| ageOfConsentStatus | Deprecated. Use go/supervised-accounts#capabilities-for-child-accounts instead. Denotes whether the user is under the region based Age of Consent. The user’s region is based on ClientUserInfo.GlobalTos.AgreedLocation The age is inferred from Birthday field or CertifiedBornBefore field. The region based AoC is specified at go/aoc. | 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. | String |
| ageRange | Deprecated. Please read go/people-api-howto:age on how to get age data. Age range is populated based on `account_birthday` and `certified_born_before`, which may not be set for dasher users. | 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. | String |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| appUniqueId | Store the app unique id endpoint. This will be passed over to app to fulfill the action. For example, app_unique_id for Whatsapp will be “[email protected]” | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo | Store all app unique info that are needed for app action fulfillment. | String |
| contactInfoSource | Where this contact info was retrieved from. Note: only added for Assistant usage, and will not be populated by PAPI. This is due to the coupling between Assistant Proto, and PAPI proto. (//depot/google3/quality/qrewrite/servlets/proto/focus_name.proto) | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo | Store all app unique info that are needed for app action fulfillment. | String |
| displayAppUniqueId | Store third party endpoint that is displayed to users. For example, display_app_unique_id for Whatsapp will be “Message +11234567890”. | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo | Store all app unique info that are needed for app action fulfillment. | String |
| label | Store third party endpoint label. For example, “HOME”, “WORK” | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo | Store all app unique info that are needed for app action fulfillment. | String |
| mimetype | Store mimetype of this endpoint. We will use this as the differentiator for Assistant to know whether to use the RawContact for messaging, call or video call. For example, send message mimetype for whatsapp: “vnd.android.cursor.item/vnd.com.whatsapp.profile” voice call mimetype for whatsapp: “vnd.android.cursor.item/vnd.com.whatsapp.voip.call” | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo | Store all app unique info that are needed for app action fulfillment. | String |
| containerType | The container the suggested name was sourced from | 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. | String |
| displayName | The display name. This name is intended to be the best name to display for this Person. It may be built from a variety of fields, even if those fields are not explicitly requested in the request mask. Generally, the display name is formatted in ‘first last’ format. If the name appears to be a CJK name (as determined by a heuristic), the ‘last first’ format will be used. There may be other cases that the ‘last first’ format is used which are not documented here. See the code at: http://google3/java/com/google/focus/backend/client/DisplayNameFormatter.java?l=659&rcl=351360938 | 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. | String |
| displayNameLastFirst | The display name, always in ‘last first’ format. This field does not depend on the format of `display_name` and will always be in ‘last first’ format. | 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. | String |
| ageDisableGracePeriod | Only supported for PROFILE/DOMAIN_PROFILE/ACCOUNT container. | 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. | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriod |
| birthdayDecoration | Whether the user has opted in to display their birthday via photo decorations. Only supported for PROFILE/DOMAIN_PROFILE container. | 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. | SocialGraphApiProtoBirthdayDecoration |
| birthdayResolution | Only supported for PROFILE/DOMAIN_PROFILE/ACCOUNT container. | 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. | String |
| calendarDay | Birthdays 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. Currently this is always returned by PeopleApi on reads that include birthday fields. New clients should write using calendar_day. Clients that were already writing via date_ms are allowlisted such that writes use that field. Old callers should migrate to writing BOTH date_ms and calendar_day values. If those are consistent, they may be removed from the ‘legacy_timestamp_event_write_behavior_enabled’ capability. | 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. | GoogleTypeDate |
| dateMs | Birthdays are currently represented as timestamp values, although the interpretation of these timestamp values is a calendar date. Clients are recommended to read the calendar_day field, which is easier to work with than date_ms. New clients writing to PeopleApi must set calendar_day instead of date_ms. There are a few important details about how this value should be mapped to a calendar date that should be consistent among all clients. 1. Epoch – The epoch or calendar date equivalent to 0 ms is chosen to be 1970-01-01 UTC. 2. Timezone – All of the conversions to calendars should occur in the UTC timezone. We don’t typically think of someones birthday changing when they travel, so clients should not use local times. 3. Calendar – The calendar used for the dates should be a Gregorian proleptic calendar. Proleptic means that the rules of the Gregorian calendar are retrofitted to before its adoption. It is easy to get this wrong, particularly with the java GregorianCalendar class, which by default is a mixed Gregorian/Julian calendar. Joda Time makes this easy, but if it’s not an option, look into GregorianCalendar.setGregorianChange(). 4. Omitted years – Clients have chosen to represent birthdays or events without years as timestamps within the year zero. When the computed date has a year of 0, it means the client did not specify a year. Note that a year 0 does not exist in a chronology like the familiar Anno Domini (A.D. and B.C.); clients must agree on year numbering. 5. Year Numbering – The chronology used to map dates to the calendar should use Astronomical Year Numbering so that the year 0 is defined and dates before it have a negative year. If libraries only provide Anno Domini, then the year of 1 BC corresponds to year zero and an omitted user provided year. Other BC values are presumed rare, but clients should still not ignore the era and interpret the year as an A.D. value, especially if writing values back to PeopleApi. | 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. | String |
| dateMsAsNumber | date_ms_as_number contains the same data as date_ms, but has a different type in generated javascript bindings. Non javascript clients can ignore it. | 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. | String |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| prompt | People Prompts settings for contact birthday data. Only supported for CONTACT container. | 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. | SocialGraphApiProtoPrompt |
| value | Actual value entered. Allows unstructured values. | 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. | String |
| calendarDay | Provisional birthday | 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. | GoogleTypeDate |
|
| gracePeriodEnd | Timestamp which signifies the end of the grace period for this account. | 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. | DateTime |
| gracePeriodStart | Timestamp which signifies the start of the grace period for this account. | 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. | DateTime |
| gracePeriodType | 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. | String | |
| manualGracePeriodInfo | 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. | AppsPeopleOzExternalMergedpeopleapiBirthdayAgeDisableGracePeriodManualGracePeriodInfo | |
| escalateTo | The Gaia ID of an email that ops can send inquiries to for appeals. | 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 | String |
| executedBy | The Gaia ID of a Googler who initiated this disable. | 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 | String |
| reason | When setting a user into age grace period manually, the requester can additionally supply a short human-readable reason of why the account is put into manual grace period. The description will be forwarded to Gaia when we disable the account when the grace period expires. | 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 | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiBraggingRights | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiBraggingRights | String | ||
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiCalendar | A url to the person’s calendar. As of 03/2018 is not supported for user Profile. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiCalendar | A url to the person’s calendar. As of 03/2018 is not supported for user Profile. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | The type of the calendar URL. The type can be free form or one of these predefined values: * `home` * `freeBusy` * `work` | AppsPeopleOzExternalMergedpeopleapiCalendar | A url to the person’s calendar. As of 03/2018 is not supported for user Profile. | String |
| url | AppsPeopleOzExternalMergedpeopleapiCalendar | A url to the person’s calendar. As of 03/2018 is not supported for user Profile. | String | |
| callerIdSource | Indicates which data source was used to populate the caller ID result | AppsPeopleOzExternalMergedpeopleapiCallerIdExtendedData | AppsPeopleOzExternalMergedpeopleapiCallerIdExtendedDataCallerIdSource | |
| sourceType | AppsPeopleOzExternalMergedpeopleapiCallerIdExtendedDataCallerIdSource | String | ||
| bornBefore | Indicates that the user was born at or before this time. | AppsPeopleOzExternalMergedpeopleapiCertifiedBornBefore | Information related to domain administrator (or authority) certification of a users age. | DateTime |
| metadata | AppsPeopleOzExternalMergedpeopleapiCertifiedBornBefore | Information related to domain administrator (or authority) certification of a users age. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| channelId | Unique ID that corresponds to a Youtube channel. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| commentCount | Number of comments for a given Youtube channel. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| description | Description of the channel. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| playlistCount | AppsPeopleOzExternalMergedpeopleapiChannelData | String | ||
| profilePictureUrl | 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. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| profileUrl | URL of user’s Youtube channel profile. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| subscriberCount | Number of subscribers for a given Youtube channel. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| title | Title of the YouTube channel | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| usesYoutubeNames | 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. | AppsPeopleOzExternalMergedpeopleapiChannelData | boolean | |
| videoCount | Number of videos uploaded in a given Youtube channel. | AppsPeopleOzExternalMergedpeopleapiChannelData | String | |
| circleId | The circle that the person belongs to. | 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. | String |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| key | AppsPeopleOzExternalMergedpeopleapiClientData | Arbitrary client data that is populated based on the client | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiClientData | Arbitrary client data that is populated based on the client | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| namespace | AppsPeopleOzExternalMergedpeopleapiClientData | Arbitrary client data that is populated based on the client | String | |
| value | AppsPeopleOzExternalMergedpeopleapiClientData | Arbitrary client data that is populated based on the client | String | |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| value | 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. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiConnectionReminder | Contact-level people-prompts settings and contact-level connection reminders. Part of go/people-prompts. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| prompt | Contact-level “reminder to connect” prompts for this contact. | AppsPeopleOzExternalMergedpeopleapiConnectionReminder | Contact-level people-prompts settings and contact-level connection reminders. Part of go/people-prompts. | list(SocialGraphApiProtoPrompt) |
| contactCreateContext | 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. | SocialGraphApiProtoContactCreateContext | |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| contactEditContext | 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. | SocialGraphApiProtoContactEditContext | |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| contactGroupId | The contact-group that the person belong to. The id can be either a hex-formatted id or a camel-cased SystemContactGroup predefined group name. The id will be predefined group name iff the system_contact_group_id has a value. | 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. | String |
| delegatedGroupInfo | Information related to delegated group that this contact belongs to. | 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. | AppsPeopleOzExternalMergedpeopleapiDelegatedGroupInfo |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| systemContactGroupId | This field will be populated when the membership is in a system-reserved contact-group. | 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. | String |
| contactPromptSettings | 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. | SocialGraphApiProtoContactPromptSettings | |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| contactState | 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. | SocialGraphApiProtoContactState | |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| imageHeight | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | integer | |
| imageId | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | String | |
| imageUrl | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | String | |
| imageWidth | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | integer | |
| isAnimated | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | boolean | |
| isDefault | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | boolean | |
| metadata | AppsPeopleOzExternalMergedpeopleapiCoverPhoto | CoverPhoto is the long banner photo (also called full bleed photo) at the top of G+ profile page. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| customerId | DEPRECATED. Use obfuscated_customer_id instead. If result has a GSuite Customer ID, this field will continue to be populated with -1 to indicate the presence of a value for backwards compatibility with clients in the wild. See b/144596193. | AppsPeopleOzExternalMergedpeopleapiCustomerInfo | Contains customer data for profile owner proxied from D3. | String |
| customerName | Customer organization name for dasher user. | AppsPeopleOzExternalMergedpeopleapiCustomerInfo | Contains customer data for profile owner proxied from D3. | String |
| obfuscatedCustomerId | Obfuscated FlexOrgs customer ID for Dasher user. See cs/symbol:CustomerIdObfuscator. | AppsPeopleOzExternalMergedpeopleapiCustomerInfo | Contains customer data for profile owner proxied from D3. | String |
| fieldDisplayName | 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). | String | |
| fieldId | 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). | String | |
| fieldType | 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). | String | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | 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). | String |
| metadata | 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). | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| multiValued | 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). | boolean | |
| schemaDisplayName | 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). | String | |
| schemaId | 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). | String | |
| type | The type of the custom schema field. The type can be free form or one of these predefined values: * `home` * `other` * `work` | 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). | String |
| value | String representation of the value, based on FieldType | 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). | String |
| containerType | See SourceIdentity.container_type | 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) | String |
| id | See SourceIdentity.id | 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) | String |
| delegatedGroupId | Required. The additional id specifically for a delegated group. | AppsPeopleOzExternalMergedpeopleapiDelegatedGroupInfo | Information related to delegated group that this contact belongs to. | SocialGraphApiProtoDelegatedGroupId |
| attributes | Attributes for this device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactExtraMetadata | Extra metadata for an aggregated or raw device contact. | list(String) |
| usageInfo | Usage info for this device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactExtraMetadata | Extra metadata for an aggregated or raw device contact. | list(SocialGraphApiProtoUsageInfo) |
| contactId | Aggregated device contact id on the source device. | AppsPeopleOzExternalMergedpeopleapiDeviceContactId | Unique id for an aggregated device contact. | String |
| deviceId | Source device id (go/client-instance-id) of this device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactId | Unique id for an aggregated device contact. | String |
| deviceContactMetadata | Metadata for this device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | AppsPeopleOzExternalMergedpeopleapiDeviceContactExtraMetadata |
| hasCrossDeviceData | Output only. True if any of the contact’s phone, email or address fields can be used on devices other than the one it originated from. Note that there can be other fields, typically name, and metadata such as some of the raw_contact_infos that can be used on other devices. Assigned by the server. | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | boolean |
| id | Id of the device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | AppsPeopleOzExternalMergedpeopleapiDeviceContactId |
| lastClientUpdateTime | Last time a device contact was updated on device. | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | DateTime |
| lookupKey | An opaque value used by the device to look up this contact if its row id changed as a result of a sync or aggregation. See: https://developer.android.com/reference/android/provider/ContactsContract.ContactsColumns.html#LOOKUP_KEY | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | String |
| rawContactInfo | Info about the raw device contacts that make up this device contact. | AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo | Device contact information. | list(AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo) |
| containerId | The container ID of the entity this field creates a join to. See `SourceIdentity.id`. | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo | String | |
| containerType | The type of container that this edge points to. See `SourceIdentity.container_type`. | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo | String | |
| extendedData | Data that is added to the proto by peopleapi read extensions. | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfoExtensionData | |
| materialized | 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. | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo | boolean | |
| gdataCompatibilityExtensionId | The GDataCompatibilityExtension will (temporarily) return mobile_owner_id for profile containers. | AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfoExtensionData | String | |
| certificate | AppsPeopleOzExternalMergedpeopleapiEmail | list(AppsPeopleOzExternalMergedpeopleapiEmailCertificate) | ||
| classification | AppsPeopleOzExternalMergedpeopleapiEmail | String | ||
| contactGroupPreference | To read or update, use the CONTACT_GROUP_PREFERENCE mask field. | AppsPeopleOzExternalMergedpeopleapiEmail | list(AppsPeopleOzExternalMergedpeopleapiEmailContactGroupPreference) | |
| displayName | AppsPeopleOzExternalMergedpeopleapiEmail | String | ||
| extendedData | AppsPeopleOzExternalMergedpeopleapiEmail | AppsPeopleOzExternalMergedpeopleapiEmailExtendedData | ||
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiEmail | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiEmail | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| signupEmailMetadata | AppsPeopleOzExternalMergedpeopleapiEmail | AppsPeopleOzExternalMergedpeopleapiEmailSignupEmailMetadata | ||
| type | The type of the email address. The type can be free form or one of these predefined values: * `home` * `work` * `other` | AppsPeopleOzExternalMergedpeopleapiEmail | String | |
| value | AppsPeopleOzExternalMergedpeopleapiEmail | String | ||
| configurationName | The name of this certificate configuration. Examples could be “High security level” or “For domain emails only”. | 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. | String |
| metadata | It is conceivable that certificates could be ACLed. We also need to indicate which certificate is the default. The PersonFieldMetadata can accomplish both of these. | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata |
| status | 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. | AppsPeopleOzExternalMergedpeopleapiEmailCertificateCertificateStatus | |
| notAfterSec | The certificate expiration timestamp in seconds. | AppsPeopleOzExternalMergedpeopleapiEmailCertificateCertificateStatus | Minimal S/MIME certificate status i.e. two fields per email address. | String |
| statusCode | Current status of the email’s certificate chain. | AppsPeopleOzExternalMergedpeopleapiEmailCertificateCertificateStatus | Minimal S/MIME certificate status i.e. two fields per email address. | String |
| contactGroupId | AppsPeopleOzExternalMergedpeopleapiEmailContactGroupPreference | Preferred email addresses for contact groups. | String | |
| isSynthetic | If the Preference was implicitly set by PeopleApi/Contacts Service. A preference with this bit will not be saved to storage. See go/contact-group-email-preference-papi-problem for more info. | AppsPeopleOzExternalMergedpeopleapiEmailContactGroupPreference | Preferred email addresses for contact groups. | boolean |
| type | AppsPeopleOzExternalMergedpeopleapiEmailContactGroupPreference | Preferred email addresses for contact groups. | String | |
| internalExternal | For use with the CUSTOMER_INFO_ADDITIONAL_DATA extension. This includes information on whether the given email is internal to or external to the requesting user’s domain. | AppsPeopleOzExternalMergedpeopleapiEmailExtendedData | Extension data for a person email. | PeoplestackFlexorgsProtoInternalExternal |
| isPlaceholder | For ListPeoplebyKnownId to indicate an email is sythesized from a lookup email. | AppsPeopleOzExternalMergedpeopleapiEmailExtendedData | Extension data for a person email. | boolean |
| smtpServerSupportsTls | For use with the TLS extension. Whether the SMTP server that handles delivery for this email address supports TLS encryption. | AppsPeopleOzExternalMergedpeopleapiEmailExtendedData | Extension data for a person email. | boolean |
| usesConfusingCharacters | For use with the Gmail Homograph Warning extension. Whether the email contains mixed character sets that could be used to decieve users. This field is populated by the GMAIL_SECURITY_DATA extension. | AppsPeopleOzExternalMergedpeopleapiEmailExtendedData | Extension data for a person email. | boolean |
| primary | This is considered to be the primary signup email. At most 1 signup email will have this set. | AppsPeopleOzExternalMergedpeopleapiEmailSignupEmailMetadata | Additional metadata for a signup email. This will only be set if the email’s classification is SIGNUP_EMAIL. | boolean |
| metadata | AppsPeopleOzExternalMergedpeopleapiEmergencyInfo | Emergency info for Person. See go/emergency-trusted-contacts-papi. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| pomeroyId | Opaque id from Pomeroy (go/pomeroy). Non-empty pomeroy_id means that this contact has the potential to become trusted contact or it’s already trusted contact. Trust is eventually gaia<->gaia link, but when the trust link is initiated gaia might not be known. Until gaia is discovered, pomeroy_id is used to identify the contact uniquely. If trust_level is missing or set to TRUST_LEVEL_UNSPECIFIED pomeroy_id must be empty. | AppsPeopleOzExternalMergedpeopleapiEmergencyInfo | Emergency info for Person. See go/emergency-trusted-contacts-papi. | String |
| trustLevel | AppsPeopleOzExternalMergedpeopleapiEmergencyInfo | Emergency info for Person. See go/emergency-trusted-contacts-papi. | String | |
| calendarDay | 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. | AppsPeopleOzExternalMergedpeopleapiEvent | GoogleTypeDate | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiEvent | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiEvent | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| prompt | People Prompts settings for contact event data. | AppsPeopleOzExternalMergedpeopleapiEvent | SocialGraphApiProtoPrompt | |
| timestampMillis | 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. | AppsPeopleOzExternalMergedpeopleapiEvent | String | |
| type | The type of the event. The type can be free form or one of these predefined values: * `anniversary` * `other` | AppsPeopleOzExternalMergedpeopleapiEvent | String | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiExternalId | External identifier associated with the person. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiExternalId | External identifier associated with the person. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | The type of the external ID. The type can be free form or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization` | AppsPeopleOzExternalMergedpeopleapiExternalId | External identifier associated with the person. | String |
| value | AppsPeopleOzExternalMergedpeopleapiExternalId | External identifier associated with the person. | String | |
| aclEntry | A custom type of field ACL entry. The set of all ACL entries includes those listed in acl_entry as well as predefined_acl_entry. | AppsPeopleOzExternalMergedpeopleapiFieldAcl | The field ACL. Currently only populated on profile fields for the profile owner. A Person field ACL; see http://go/peopleapi-acl | list(AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntry) |
| authorizedViewers | Set of users that will be authorized to view the field by this field ACL. If the ACL is public, this will only contain ALL_USERS. This field is synthesized, read-only, and currently only used for profile photos. It’s populated under “person.photo.metadata.field_acl” for the current photo ACL and “person.photo.metadata.acl_choices” for available photo ACL choices. Note: The set of authorized viewers for a given FieldAcl may depend on the user’s account type and domain configuration. For example, a PRIVATE_READ FieldAcl could have any of the following authorized viewers: Consumer user: [IDENTITY_ACL_ESTABLISHED] Dasher user without domain contact sharing: [IDENTITY_ACL_ESTABLISHED] Unicorn user: [SAME_UNICORN_FAMILY] Hafez user: [] | AppsPeopleOzExternalMergedpeopleapiFieldAcl | The field ACL. Currently only populated on profile fields for the profile owner. A Person field ACL; see http://go/peopleapi-acl | list(String) |
| predefinedAclEntry | A common type of field ACL entry. A predefined ACL entry is a shortcut for a commonly occurring case of role and scope. For example, PUBLIC_READ is the same as an AclEntry with role = READER and scope.all_users = true. The set of all ACL entries includes those listed in acl_entry as well as predefined_acl_entry. | AppsPeopleOzExternalMergedpeopleapiFieldAcl | The field ACL. Currently only populated on profile fields for the profile owner. A Person field ACL; see http://go/peopleapi-acl | list(String) |
| role | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntry | String | ||
| scope | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntry | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope | ||
| allUsers | Indicates that the field is accessible to all users including unauthenticated users. For some fields this means “to everyone except blocked users”. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope | boolean | |
| domainUsers | 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. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope | boolean | |
| membership | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAcl | ||
| person | Indicates that the field is accessible to a person. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScope | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopePersonAcl | |
| circle | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAcl | Used when the field is accessible to a membership that the person has. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclCircleAcl | |
| contactGroup | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAcl | Used when the field is accessible to a membership that the person has. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclContactGroupAcl | |
| circleId | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclCircleAcl | Used when a field is accessible to a circle. | String | |
| circleSet | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclCircleAcl | Used when a field is accessible to a circle. | String | |
| displayName | Equivalent to Circle.display_name for the circle_id. Included when FieldAclOption.FULL_ACL_WITH_DETAILS is requested. This field is read-only and ignored on update. | AppsPeopleOzExternalMergedpeopleapiFieldAclAclEntryScopeMembershipAclCircleAcl | Used when a field is accessible to a circle. | String |
| contactGroupId | A contact group ID. This is either a user-defined contact group hex ID, or it is the string name of the enum constant in Group.PredefinedId in FBS backend.proto for predefined groups. Common values for the predefined name include, but are not limited to: all, myContacts, starred, chatBuddies, friends, family, coworkers, and blocked. | 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. | String |
| displayName | The localized display name for the predefined group, if known; or, the display name for the user-defined contact group. Included when FieldAclOption.FULL_ACL_WITH_DETAILS is requested. | 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. | String |
| displayName | DEPRECATED. This is not different than reading from person.name for a self-read; ACLs to a circle or to a non-self person are no longer supported. Equivalent to Name.display_name for the person_id profile. Included when the profile Name is ACLed to the requester and FieldAclOption.FULL_ACL_WITH_DETAILS is requested. This field is read-only and ignored on update. | 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. | String |
| personId | 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. | String | |
| photoUrl | DEPRECATED. This is not different than reading from person.photo for a self-read; ACLs to a circle or to a non-self person are no longer supported. Equivalent to Photo.url for the person_id profile. Included when the profile Photo is ACLed to the requester and FieldAclOption.FULL_ACL_WITH_DETAILS is requested. This field is read-only and ignored on update. | 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. | String |
| emergencyLevel | AppsPeopleOzExternalMergedpeopleapiFieldEmergencyInfo | Emergency information for Person field, such as Phone or Email. See go/emergency-trusted-contacts-papi. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiFileAs | The FileAs field in Contacts is used to override the DisplayName of a Contact for that User. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| value | AppsPeopleOzExternalMergedpeopleapiFileAs | The FileAs field in Contacts is used to override the DisplayName of a Contact for that User. | String | |
| addressMeAs | Preferred pronoun choice. It’s unclear whether this value is constrained to a finite domain by UIs. `address_me_as` may be populated regardless of whether `type` is “male”, “female”, or “other”, although most writers only set it if `type` is “other”. | 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. | String |
| customType | A free-form string indicating what the user entered as their gender. `custom_type` may exist even if the type is “male” or “female”, although most writers do not set it unless `type` is “other”. | 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. | String |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | 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. | String |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | The gender. “male”, “female”, or “other”. If “other”, typically, additional fields will have additional information. | 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. | String |
| failure | Failure type if there is an error when fetching product profile data. | AppsPeopleOzExternalMergedpeopleapiGPayExtendedData | Extension data for use in GPay Product Profile. go/gpay-product-profile-1-pager Contact: [email protected] | AppsPeopleOzExternalMergedpeopleapiProductProfileFailure |
| internationalNumber | A number in international format including the country code that is made user readable by including formatting such as spaces. Example: “+41 44 668 1800” DEPRECATED: A user’s phone number should be masked and not in an international format | AppsPeopleOzExternalMergedpeopleapiGPayExtendedData | Extension data for use in GPay Product Profile. go/gpay-product-profile-1-pager Contact: [email protected] | String |
| maskedNumber | The masked string of a user’s phone number The number will be obfucsated with * except the last 4 digits. Refer to: //java/com/google/nbu/paisa/common/PhoneNumberMasker.java | AppsPeopleOzExternalMergedpeopleapiGPayExtendedData | Extension data for use in GPay Product Profile. go/gpay-product-profile-1-pager Contact: [email protected] | String |
| contentRestriction | AppsPeopleOzExternalMergedpeopleapiGplusExtendedData | String | ||
| isEnterpriseUser | Equivalent to having the DASHER_POLICY bit in the REGISTERED state. | AppsPeopleOzExternalMergedpeopleapiGplusExtendedData | boolean | |
| hadPastHangoutState | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | String | |
| invitationStatus | Populated for all contacts. Only set if had_past_hangout_state == HAD_PAST_HANGOUT. INVITATION_NEEDED is not a valid value because there already is a past hangout, which means either the invitation is still pending or it’s been accepted. | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | String |
| isBot | True if this is a Hangouts bot. | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | boolean |
| isDismissed | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | boolean | |
| isFavorite | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | boolean | |
| isPinned | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | boolean | |
| userType | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData | Extension data for use in Hangouts. | String | |
| originalLookupToken | Original lookup token from the request that resulted in this person or one of its containers. | AppsPeopleOzExternalMergedpeopleapiIdentityInfo | list(String) | |
| previousPersonId | 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. | AppsPeopleOzExternalMergedpeopleapiIdentityInfo | list(String) | |
| sourceIds | A list of sources contributing to the merged person, including profiles (with gaia-id), contacts and synthetic-contacts. | AppsPeopleOzExternalMergedpeopleapiIdentityInfo | list(AppsPeopleOzExternalMergedpeopleapiSourceIdentity) | |
| formattedProtocol | The `protocol` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiIm | String | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiIm | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiIm | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| protocol | 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` | AppsPeopleOzExternalMergedpeopleapiIm | String | |
| type | The type of the IM. The type can be free form or one of these predefined values: * `home` * `work` * `other` | AppsPeopleOzExternalMergedpeopleapiIm | String | |
| value | AppsPeopleOzExternalMergedpeopleapiIm | String | ||
| app | 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 = [email protected] 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 ] | list(String) | |
| clientData | 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 = [email protected] 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 ] | list(AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetClientData) | |
| metadata | 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 = [email protected] 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 ] | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| originatingField | There may be more than one field from which this IANT originates, as in the case of Bob’s public profile. | 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 = [email protected] 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 ] | list(AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetOriginatingField) |
| type | 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 = [email protected] 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 ] | String | |
| value | The value of the target, used for delivery. E.g., the obfuscated gaia ID for a visible profile. | 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 = [email protected] 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 ] | String |
| app | The app to which this client data applies. | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetClientData | Client-specific data pertaining to app reachability. No PII data or user content should be stored in this blob. | String |
| byteValue | AppsPeopleOzExternalMergedpeopleapiInAppNotificationTargetClientData | Client-specific data pertaining to app reachability. No PII data or user content should be stored in this blob. | String | |
| fieldIndex | The index of the relevant field in the merged person | 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. | integer |
| fieldType | 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. | String | |
| value | The value of the origin field | 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. | String |
| appType | 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. | String | |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| reachabilityKey | 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. | AppsPeopleOzExternalMergedpeopleapiInAppReachabilityReachabilityKey | |
| status | 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. | String | |
| keyType | AppsPeopleOzExternalMergedpeopleapiInAppReachabilityReachabilityKey | Information pertaining to how this reachable state was established. | String | |
| keyValue | The value of the key by which the user said they may be reachable. E.g., the phone number. | AppsPeopleOzExternalMergedpeopleapiInAppReachabilityReachabilityKey | Information pertaining to how this reachable state was established. | String |
| allowed | AppsPeopleOzExternalMergedpeopleapiInteractionSettings | Defines interactions that are allowed or disallowed with this person. | boolean | |
| interaction | AppsPeopleOzExternalMergedpeopleapiInteractionSettings | Defines interactions that are allowed or disallowed with this person. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiInteractionSettings | Defines interactions that are allowed or disallowed with this person. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| metadata | AppsPeopleOzExternalMergedpeopleapiInterest | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiInterest | String | ||
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| value | 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. | String | |
| lat | AppsPeopleOzExternalMergedpeopleapiLatLng | float | ||
| lng | AppsPeopleOzExternalMergedpeopleapiLatLng | float | ||
| mobileOwnerId | Mobile obfuscated gaia id. This is the same gaia id in metadata.owner_id, but obfuscated with the legacy mobile obfuscator. | AppsPeopleOzExternalMergedpeopleapiLegacyFields | Fields used in legacy applications. Useful for joining legacy and new data streams. Most applications should not care about these fields. | String |
| limitedProfileSettings | AppsPeopleOzExternalMergedpeopleapiLimitedProfileSettingsField | SocialGraphApiProtoLimitedProfileSettings | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiLimitedProfileSettingsField | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| buildingId | AppsPeopleOzExternalMergedpeopleapiLocation | String | ||
| buildingName | The building_name field is only filled if the DESK_LOCATION_ADDITIONAL_DATA extension is active. | AppsPeopleOzExternalMergedpeopleapiLocation | String | |
| current | AppsPeopleOzExternalMergedpeopleapiLocation | boolean | ||
| deskCode | Most specific textual description of individual desk location. | AppsPeopleOzExternalMergedpeopleapiLocation | String | |
| floorName | AppsPeopleOzExternalMergedpeopleapiLocation | String | ||
| floorSection | AppsPeopleOzExternalMergedpeopleapiLocation | String | ||
| lastUpdateTime | Indicates the time this location was added or last edited. | AppsPeopleOzExternalMergedpeopleapiLocation | DateTime | |
| metadata | AppsPeopleOzExternalMergedpeopleapiLocation | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| source | Value indicates the origin of this location information. | AppsPeopleOzExternalMergedpeopleapiLocation | String | |
| type | Describes the type of location. E.g. Grew_up, Desk. Corresponds to FBS backend.proto Location.StandardTag | AppsPeopleOzExternalMergedpeopleapiLocation | String | |
| value | AppsPeopleOzExternalMergedpeopleapiLocation | String | ||
| indirectManager | List of managers in the chain. If user has manager email “[email protected]” and manager’s manager has email “[email protected]” then the list will be: [0]: { email: “[email protected]” } [1]: { email: “[email protected]” } | AppsPeopleOzExternalMergedpeopleapiManagementUpchain | list(AppsPeopleOzExternalMergedpeopleapiManagementUpchainIndirectManager) | |
| metadata | AppsPeopleOzExternalMergedpeopleapiManagementUpchain | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| status | AppsPeopleOzExternalMergedpeopleapiManagementUpchain | String | ||
| AppsPeopleOzExternalMergedpeopleapiManagementUpchainIndirectManager | String | |||
| personId | AppsPeopleOzExternalMergedpeopleapiManagementUpchainIndirectManager | String | ||
| failure | Failure type if there is an error when fetching product profile data. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | AppsPeopleOzExternalMergedpeopleapiProductProfileFailure |
| followeeCount | Number of people the user is following. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | String |
| followerCount | Number of people who are following the user. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | integer |
| numContributions | Sum of creators contributions i.e. reviews, rating, questions, etc. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | String |
| profilePhotoUrl | The user’s profile photo that might have a badge rendered at the corner if the user is eligible for a badge. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | String |
| tagline | A user’s bio, or tagline. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | String |
| topicExpertise | A topic that creator has expertise in. This will be in the format: emoji associated with the topic, display name of the topic, topic score | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | list(String) |
| userCaption | A user’s caption displayed under the user name on their profile page i.e. ‘Local Guide Level 8’ | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData | Extension data for use in Maps Product Profile. | String |
| fieldRestriction | AppsPeopleOzExternalMergedpeopleapiMapsProfile | Maps Profile Data. See go/product-profiles-backend-api. | list(AppsPeopleOzExternalMergedpeopleapiMapsProfileFieldRestriction) | |
| metadata | AppsPeopleOzExternalMergedpeopleapiMapsProfile | Maps Profile Data. See go/product-profiles-backend-api. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| tagline | AppsPeopleOzExternalMergedpeopleapiMapsProfile | Maps Profile Data. See go/product-profiles-backend-api. | String | |
| websiteLink | A link to the profile owner’s website to be displayed in profile. | AppsPeopleOzExternalMergedpeopleapiMapsProfile | Maps Profile Data. See go/product-profiles-backend-api. | AppsPeopleOzExternalMergedpeopleapiMapsProfileUrlLink |
| clientData | Opaque data associated with this restriction e.g. abuse status. | AppsPeopleOzExternalMergedpeopleapiMapsProfileFieldRestriction | String | |
| type | AppsPeopleOzExternalMergedpeopleapiMapsProfileFieldRestriction | String | ||
| anchorText | Anchor text to be displayed as clickable link. If not present, the URL should be displayed directly. | AppsPeopleOzExternalMergedpeopleapiMapsProfileUrlLink | String | |
| url | The URL to be linked to. | AppsPeopleOzExternalMergedpeopleapiMapsProfileUrlLink | String | |
| match | The list of matches ordered by most relevant matching for autocomplete coming first. | AppsPeopleOzExternalMergedpeopleapiMatchInfo | Represents the matching information for a field when there is a query. | list(AppsPeopleOzExternalMergedpeopleapiMatchInfoLookupTokenMatch) |
| query | The query token we are matching against. | AppsPeopleOzExternalMergedpeopleapiMatchInfo | Represents the matching information for a field when there is a query. | String |
| endIndex | Index right after the last character that matches the query. length = end-start, we have substring = [start, end). | AppsPeopleOzExternalMergedpeopleapiMatchInfoLookupTokenMatch | All the substring that were matched for the given query against the current field. Represents a substring of another string. | integer |
| startIndex | Index of the first unicode character that matches the query. | AppsPeopleOzExternalMergedpeopleapiMatchInfoLookupTokenMatch | All the substring that were matched for the given query against the current field. Represents a substring of another string. | integer |
| circleId | A circle that the person belongs to. | 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. | String |
| contactGroupId | A contact-group that the person belong to. The id can be either a hex-formatted id or a camel-cased SystemContactGroup predefined group name. The id will be predefined group name iff the system_contact_group_id has a value. | 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. | String |
| metadata | The metadata field can be used to determine which container generated the membership. For example, when the membership has a contact_group_id, the metadata.container will be CONTACT and the container_id will be the contact Id. | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata |
| systemContactGroupId | The membership has a contact_group_id, this field will be populated when the membership is in a system-reserved contact-group. | 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. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiMission | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiMission | String | ||
| displayName | Read-only. A name synthesized based on `unstructured_name` and the structured name fields. Example: “John Smith” If a language code is passed in the side channel using http://cs/symbol:framework.rpc.DeprecatedPropagatedLanguageCode.value or http://cs/symbol:google.rpc.context.OriginContext.accept_language and the name does not have `honorific_prefix`, `middle_name`, or `honorific_suffix` set, the language code will be used to format `display_name`. If `include_account_locale` is set on the `MergePersonSourceOptions` and a language code is not passed in the side channel. The language code from go/uls will be used as the language code for formatting `display_name`. | 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. | String |
| displayNameLastFirst | Read-only. A name synthesized based on `unstructured_name` and the structured name fields with the last name first. Example: “Smith, John” | 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. | String |
| displayNameSource | Read-only. The source of the display name. | 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. | SocialGraphApiProtoDisplayNameSource |
| familyName | 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. | String | |
| formattedName | DEPRECATED(b/70571931). Use `unstructured_name` instead. | 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. | String |
| givenName | 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. | String | |
| honorificPrefix | 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. | String | |
| honorificSuffix | 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. | String | |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| middleName | 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. | String | |
| pronunciations | This field is stored in contact annotations and merged at read-time. It is available with CONTACT_ANNOTATION container type at read time. | 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. | SocialGraphApiProtoPronunciations |
| shortDisplayName | NOTE: this is currently NOT IMPLEMENTED due to changed priorities. Clients usually rely on “first name” instead, when a short name is needed. Read-only. A possibly shorter version of the user’s name. – The purpose of this field is to address the needs of UIs where a full display name might be too large to fit. Instead of relying on `first_name`, which might not be present, `short_display_name` is preferred. – This is only available for PROFILE and DOMAIN_PROFILE container types. – About the actual content in this field: will be the first name when it’s visible to the requester, or the same as `display_name`, otherwise. A sample scenario where the first name may not be visible is when the limited profile is returned. For more info, see: http://shortn/_9iV7TJ33la | 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. | String |
| unstructuredName | The free form name value. For contact mutates it is recommended for clients to set either the `unstructured_name` or the set of structured name fields, not both. | 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. | String |
| yomiFamilyName | 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. | String | |
| yomiFullName | 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. | String | |
| yomiGivenName | 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. | String | |
| yomiHonorificPrefix | 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. | String | |
| yomiHonorificSuffix | 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. | String | |
| yomiMiddleName | 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. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiNamePronunciationAudioMetadataInfo | Pronunciation audio metadata info. See go/name-pronunciation-backend. The metadata itself tracks the state of a user’s name pronunciation audio. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| namePronunciationAudioMetadata | Actual metadata proto, shared with FBS backends. | AppsPeopleOzExternalMergedpeopleapiNamePronunciationAudioMetadataInfo | Pronunciation audio metadata info. See go/name-pronunciation-backend. The metadata itself tracks the state of a user’s name pronunciation audio. | SocialGraphApiProtoNamePronunciationAudioMetadata |
| metadata | AppsPeopleOzExternalMergedpeopleapiNickname | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| type | AppsPeopleOzExternalMergedpeopleapiNickname | String | ||
| value | AppsPeopleOzExternalMergedpeopleapiNickname | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiOccupation | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiOccupation | String | ||
| openNow | Is this place open right now? Always present unless we lack time-of-day or timezone data for these opening hours. | 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. | boolean |
| periods | 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. | list(AppsPeopleOzExternalMergedpeopleapiOpeningHoursPeriod) | |
| weekdayTexts | Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: “Sun: 18:00-06:00” | 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. | list(String) |
| day | A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is Monday, etc. | AppsPeopleOzExternalMergedpeopleapiOpeningHoursEndpoint | integer | |
| time | A time in 24-hour “hhmm” format (i.e. range is 0000 to 2359). | AppsPeopleOzExternalMergedpeopleapiOpeningHoursEndpoint | String | |
| close | AppsPeopleOzExternalMergedpeopleapiOpeningHoursPeriod | AppsPeopleOzExternalMergedpeopleapiOpeningHoursEndpoint | ||
| open | AppsPeopleOzExternalMergedpeopleapiOpeningHoursPeriod | AppsPeopleOzExternalMergedpeopleapiOpeningHoursEndpoint | ||
| assignment | AppsPeopleOzExternalMergedpeopleapiOrganization | list(AppsPeopleOzExternalMergedpeopleapiOrganizationAssignment) | ||
| certification | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| costCenter | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| current | AppsPeopleOzExternalMergedpeopleapiOrganization | boolean | ||
| department | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| description | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| domain | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| endCalendarDay | 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. | AppsPeopleOzExternalMergedpeopleapiOrganization | GoogleTypeDate | |
| endMs | 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. | AppsPeopleOzExternalMergedpeopleapiOrganization | String | |
| endMsAsNumber | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| formattedStringType | The `string_type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiOrganization | String | |
| fteMilliPercent | AppsPeopleOzExternalMergedpeopleapiOrganization | integer | ||
| importance | AppsPeopleOzExternalMergedpeopleapiOrganization | number | ||
| location | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiOrganization | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| name | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| project | AppsPeopleOzExternalMergedpeopleapiOrganization | list(AppsPeopleOzExternalMergedpeopleapiOrganizationProject) | ||
| startCalendarDay | 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. | AppsPeopleOzExternalMergedpeopleapiOrganization | GoogleTypeDate | |
| startMs | 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. | AppsPeopleOzExternalMergedpeopleapiOrganization | String | |
| startMsAsNumber | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| stringType | The type of the organization. The type can be free form or one of these predefined values: * `work` * `school` | AppsPeopleOzExternalMergedpeopleapiOrganization | String | |
| symbol | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| title | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| type | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| yomiName | AppsPeopleOzExternalMergedpeopleapiOrganization | String | ||
| name | AppsPeopleOzExternalMergedpeopleapiOrganizationAssignment | String | ||
| url | AppsPeopleOzExternalMergedpeopleapiOrganizationAssignment | String | ||
| description | AppsPeopleOzExternalMergedpeopleapiOrganizationProject | String | ||
| name | AppsPeopleOzExternalMergedpeopleapiOrganizationProject | String | ||
| role | AppsPeopleOzExternalMergedpeopleapiOrganizationProject | String | ||
| type | Mapped from StandardProjectTag / CustomProjectTag | AppsPeopleOzExternalMergedpeopleapiOrganizationProject | String | |
| url | AppsPeopleOzExternalMergedpeopleapiOrganizationProject | String | ||
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiOtherKeyword | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiOtherKeyword | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| source | AppsPeopleOzExternalMergedpeopleapiOtherKeyword | String | ||
| type | The type of the event. The type depends on the `OtherKeyword.source`. `OUTLOOK` source fields must be one of: * `billing_information` * `directory_server` * `keyword` * `mileage` * `sensitivity` * `user` * `subject` All other fields are treated as a `CUSTOM` source field. The value can be free form or one of these predefined values: * `home` * `other` * `work` | AppsPeopleOzExternalMergedpeopleapiOtherKeyword | String | |
| value | AppsPeopleOzExternalMergedpeopleapiOtherKeyword | String | ||
| relation | See go/relation-vs-relationship for relation vs relationship explanation. | 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 | list(AppsPeopleOzExternalMergedpeopleapiRelation) |
| photo | See go/people-api-concepts/photos for usage details | 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 | list(AppsPeopleOzExternalMergedpeopleapiPhoto) |
| organization | 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 | list(AppsPeopleOzExternalMergedpeopleapiOrganization) | |
| mission | 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 | list(AppsPeopleOzExternalMergedpeopleapiMission) | |
| customSchemaField | 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 | list(AppsPeopleOzExternalMergedpeopleapiCustomSchemaField) | |
| coverPhoto | DEPRECATED. Now always returns a default cover photo. See go/sunset-cover-photo. | 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 | list(AppsPeopleOzExternalMergedpeopleapiCoverPhoto) |
| linkedPerson | Other person resources linked indirectly by an edge. The full person or just the IDs may be populated depending on request parameters. We consider linked people distinct people, but they share information. Example: A contact with two outgoing edges. The two edges are considered separate, but linked people. | 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 | list(AppsPeopleOzExternalMergedpeopleapiPerson) |
| name | See go/people-api-howto:names for details about names in PeopleAPI. | 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 | list(AppsPeopleOzExternalMergedpeopleapiName) |
| sortKeys | 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 | AppsPeopleOzExternalMergedpeopleapiSortKeys | |
| sipAddress | SipAddress is currently in use by contacts. | 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 | list(AppsPeopleOzExternalMergedpeopleapiSipAddress) |
| inAppReachability | Used only by profile service, deprecated for PeopleAPI and Sharpen. If you aren’t sure, contact people-api-users@ and profile-service-eng@. | 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 | list(AppsPeopleOzExternalMergedpeopleapiInAppReachability) |
| calendar | b/145671020: Deprecated for Profiles, but not for Contacts. | 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 | list(AppsPeopleOzExternalMergedpeopleapiCalendar) |
| socialConnection | NOTE: this is used by go/starlight, but not actually used or returned in PeopleAPI. See b/27281119 for context. Please reach out to people-api-eng@ if you have questions. | 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 | list(AppsPeopleOzExternalMergedpeopleapiSocialConnection) |
| plusPageInfo | DEPRECATED. Info about plus pages in the person. | 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 | list(AppsPeopleOzExternalMergedpeopleapiPlusPageInfo) |
| externalId | 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 | list(AppsPeopleOzExternalMergedpeopleapiExternalId) | |
| mapsProfile | MapsProfile, see go/product-profiles-backend-api | 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 | list(AppsPeopleOzExternalMergedpeopleapiMapsProfile) |
| tagline | Only supported for PLACE container results, no data will be returned for profiles. | 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 | list(AppsPeopleOzExternalMergedpeopleapiTagline) |
| interactionSettings | DEPRECATED. This field isn’t populated in people.list. | 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 | list(AppsPeopleOzExternalMergedpeopleapiInteractionSettings) |
| peopleInCommon | DEPRECATED. This feature was stubbed, but never implemented. This field will not be populated with any results. | 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 | list(AppsPeopleOzExternalMergedpeopleapiPerson) |
| connectionReminder | Reminder to connect with a Contact (part of go/people-prompts). Also contains contact-level prompts settings. Each Contact can have a single `connection_reminder` (but can have multiple Prompts inside of it). Field is repeated per PeopleAPI data model go/people-api-concepts#repeated. Only supported for CONTACT container. | 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 | list(AppsPeopleOzExternalMergedpeopleapiConnectionReminder) |
| limitedProfileSettings | Settings for the limited profile. See go/limited-profiles-api. | 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 | list(AppsPeopleOzExternalMergedpeopleapiLimitedProfileSettingsField) |
| metadata | 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 | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | |
| birthday | 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 | list(AppsPeopleOzExternalMergedpeopleapiBirthday) | |
| 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 | list(AppsPeopleOzExternalMergedpeopleapiEmail) | ||
| otherKeyword | Legacy arbitrary key value fields | 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 | list(AppsPeopleOzExternalMergedpeopleapiOtherKeyword) |
| inAppNotificationTarget | Ways to send in-app notifications to this person. See go/reachability. This field is read-only and ignored for mutates. | 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 | list(AppsPeopleOzExternalMergedpeopleapiInAppNotificationTarget) |
| placeDetails | Data specific to places. Data which also applies to contacts and profiles such as name, phone, photo, etc. are returned in the corresponding Person fields. | 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 | list(AppsPeopleOzExternalMergedpeopleapiPlaceDetails) |
| rightOfPublicityState | 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 | list(AppsPeopleOzExternalMergedpeopleapiRightOfPublicityState) | |
| im | 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 | list(AppsPeopleOzExternalMergedpeopleapiIm) | |
| legacyFields | DEPRECATED. This field was only for backwards compatibility with legacy GData callers, and should not be used by new clients. Legacy fields used for mobile clients. | 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 | AppsPeopleOzExternalMergedpeopleapiLegacyFields |
| occupation | 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 | list(AppsPeopleOzExternalMergedpeopleapiOccupation) | |
| sshPublicKey | 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 | list(AppsPeopleOzExternalMergedpeopleapiSshPublicKey) | |
| namePronunciationAudioMetadataInfo | Metadata info for a user’s name pronunciation audio. See go/name-pronunication-backend. | 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 | list(AppsPeopleOzExternalMergedpeopleapiNamePronunciationAudioMetadataInfo) |
| relationshipInterest | DEPRECATED. No data is returned for this field anymore. | 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 | list(AppsPeopleOzExternalMergedpeopleapiRelationshipInterest) |
| skills | 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 | list(AppsPeopleOzExternalMergedpeopleapiSkills) | |
| contactPromptSettingsInfo | 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 | list(AppsPeopleOzExternalMergedpeopleapiContactPromptSettingsInfo) | |
| profileUrl | DEPRECATED. No data is returned for this field anymore. (go/people-api-concepts#repeated): Use person.profile_url_repeated instead. Access to this field is restricted to a set of legacy clients. This is a Google+-only field. See go/fbs-g+-deprecation. NOTE: `Person.profile_url` is only populated for profile-centric person. | 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 | String |
| managementUpchain | 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 | list(AppsPeopleOzExternalMergedpeopleapiManagementUpchain) | |
| contactEditContextInfo | ContactEditContextInfo is a timestamp and additional metadata (e.g. the source of the edit) for the last ‘human initiated edit’. See also `ContactCreateContextInfo`. | 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 | list(AppsPeopleOzExternalMergedpeopleapiContactEditContextInfo) |
| website | 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 | list(AppsPeopleOzExternalMergedpeopleapiWebsite) | |
| phone | 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 | list(AppsPeopleOzExternalMergedpeopleapiPhone) | |
| teamsExtendedData | DEPRECATED. *UNSUPPORTED*. This field is never populated. | 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 | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData |
| contactCreateContextInfo | ContactCreateContextInfo has a timestamp timestamp and additional metadata (e.g. the source of the creation) for when the contact was created. See also `ContactEditContextInfo`. | 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 | list(AppsPeopleOzExternalMergedpeopleapiContactCreateContextInfo) |
| personAttribute | In order to request this field, the client must set desired PersonAttributeKey in the dedicated RequestMask field `person_attribute`. Unlike other person fields, this field cannot be requested in the `include_field` field mask. | 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 | list(AppsPeopleOzExternalMergedpeopleapiPersonAttribute) |
| location | 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 | list(AppsPeopleOzExternalMergedpeopleapiLocation) | |
| pronoun | Pronouns are not supported for consumer profiles. See go/pronouns-in-people-system-prd for more details. | 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 | list(AppsPeopleOzExternalMergedpeopleapiPronoun) |
| ageRangeRepeated | Data on the person’s age range, adult status, and age of consent. NOTE: Please read go/people-api-howto:age on how to correctly get age data. | 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 | list(AppsPeopleOzExternalMergedpeopleapiAgeRangeType) |
| posixAccount | 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 | list(AppsPeopleOzExternalMergedpeopleapiPosixAccount) | |
| language | 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 | list(AppsPeopleOzExternalMergedpeopleapiLanguage) | |
| profileUrlRepeated | DEPRECATED. No data is returned for this field anymore. This is a Google+-only field. See go/fbs-g+-deprecation. | 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 | list(AppsPeopleOzExternalMergedpeopleapiProfileUrl) |
| userDefined | UserDefined is currently in use by contacts. | 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 | list(AppsPeopleOzExternalMergedpeopleapiUserDefined) |
| event | Event is currently in use by contacts. | 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 | list(AppsPeopleOzExternalMergedpeopleapiEvent) |
| rosterDetails | Data specific to rosters (such as Google Groups and Chat Rooms). Data which also applies to contacts and profiles such as name, email, and photo, etc are returned in the corresponding Person fields. | 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 | list(AppsPeopleOzExternalMergedpeopleapiRosterDetails) |
| emergencyInfo | Emergency information. See go/emergency-trusted-contacts-papi. | 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 | list(AppsPeopleOzExternalMergedpeopleapiEmergencyInfo) |
| visibleToGuests | Add annotation_id and metadata (product_source) for visible to guests contacts go/visible-to-guests. | 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 | list(AppsPeopleOzExternalMergedpeopleapiVisibleToGuests) |
| ageRange | Deprecated. If age is needed use `person.age_range_repeated` instead. Please see go/people-api-howto:age on how to correctly get age data. | 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 | String |
| searchProfile | Profile for Janata and Search. go/janata-profile-in-sgbe | 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 | list(AppsPeopleOzExternalMergedpeopleapiSearchProfile) |
| contactStateInfo | Contact state and related metadata. See go/fbs-contacts-trash. If this field was requested but is not set on the Person then the contact is in the DEFAULT contact state. This field is read-only, and should not be set on a mutate (e.g. UpdatePerson) call. Clients must call the explicit APIs (e.g. UntrashPerson) to change contact state. | 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 | list(AppsPeopleOzExternalMergedpeopleapiContactStateInfo) |
| extendedData | Data added by extensions that are not specific to a particular field. | 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 | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData |
| nickname | 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 | list(AppsPeopleOzExternalMergedpeopleapiNickname) | |
| about | 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 | list(AppsPeopleOzExternalMergedpeopleapiAbout) | |
| personId | The ID of the person. This is determined by the backend, is unstable, and may not be the same as a user_id. Internally referred as ‘personKey’ to distinguish from the common PersonId pojo. See go/people-api-concepts#person-id | 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 | String |
| fileAs | 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 | list(AppsPeopleOzExternalMergedpeopleapiFileAs) | |
| readOnlyProfileInfo | Information about the profiles that are a part of this Person. This is only applicable to PROFILE and DOMAIN_PROFILE containers. | 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 | list(AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfo) |
| relationshipStatus | DEPRECATED. No data is returned for this field anymore. | 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 | list(AppsPeopleOzExternalMergedpeopleapiRelationshipStatus) |
| interest | 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 | list(AppsPeopleOzExternalMergedpeopleapiInterest) | |
| contactGroupMembership | Contact groups that this person is a member of. | 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 | list(AppsPeopleOzExternalMergedpeopleapiContactGroupMembership) |
| address | 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 | list(AppsPeopleOzExternalMergedpeopleapiAddress) | |
| circleMembership | Circles that this person is a member of. | 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 | list(AppsPeopleOzExternalMergedpeopleapiCircleMembership) |
| certifiedBornBefore | 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 | list(AppsPeopleOzExternalMergedpeopleapiCertifiedBornBefore) | |
| braggingRights | Used only by contacts, no data will be returned for profiles. | 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 | list(AppsPeopleOzExternalMergedpeopleapiBraggingRights) |
| gender | 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 | list(AppsPeopleOzExternalMergedpeopleapiGender) | |
| fingerprint | A fingerprint that can be used to reliably determine if a resource has changed. Externally it is used as part of the etag. | 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 | String |
| membership | DEPRECATED. Please use `circle_membership` or `contact_group_membership` instead. Contact-groups and circles that this person is a member of. | 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 | list(AppsPeopleOzExternalMergedpeopleapiMembership) |
| communicationEmail | 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 | list(AppsPeopleOzExternalMergedpeopleapiCommunicationEmail) | |
| clientData | 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 | list(AppsPeopleOzExternalMergedpeopleapiClientData) | |
| attributeKey | AppsPeopleOzExternalMergedpeopleapiPersonAttribute | Client-specific binary blob stored with Person data. This differs from ClientData, which stores structured, key-value pairs. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPersonAttribute | Client-specific binary blob stored with Person data. This differs from ClientData, which stores structured, key-value pairs. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| value | AppsPeopleOzExternalMergedpeopleapiPersonAttribute | Client-specific binary blob stored with Person data. This differs from ClientData, which stores structured, key-value pairs. | String | |
| aboutMeExtendedData | For use by AboutMe and SmartProfile clients. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiAboutMeExtendedData |
| appsWaldoExtendedData | For use with Apps Waldo Availability Data extension | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | SocialGraphWireProtoPeopleapiExtensionAppsWaldoExtendedData |
| callerIdExtendedData | For use with caller ID extension | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiCallerIdExtendedData |
| contactsExtendedData | For use with Contacts extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiWebContactsExtendedData |
| domainName | Hosted domain this person is a member of. The domain_name is also returned as part of the person’s ReadOnlyProfileInfo, so requesting it via this extension is no longer necessary. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | list(String) |
| dynamiteExtendedData | For use with Dynamite extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | SocialGraphWireProtoPeopleapiExtensionDynamiteExtendedData |
| gpayExtendedData | For use with Google Pay extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiGPayExtendedData |
| gplusExtendedData | For use with Google+ extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiGplusExtendedData |
| hangoutsExtendedData | For use with Hangouts extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiHangoutsExtendedData |
| isPlaceholder | For use with gmail extensions and lookup by email. If true, no person was actually found using the specified email address, but we want to return TLS info about the email address regardless. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | boolean |
| mapsExtendedData | For use with Maps extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiMapsExtendedData |
| paisaExtendedData | For use with Paisa extension | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | SocialGraphWireProtoPeopleapiExtensionPaisaExtendedData |
| peopleStackExtendedData | DEPRECATED: Use people_stack_person_extended_data instead. For use with PeopleStack extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | SocialGraphWireProtoPeopleapiExtensionPeopleStackExtendedData |
| peopleStackPersonExtendedData | For use with PeopleStack extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData |
| playGamesExtendedData | For use with Play Games Product Profile extension. See go/jam-games-profile. The play games profile will be returned only for profile-centric requests. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData |
| tlsIsPlaceholder | For use with the TLS extension and lookup by email. If true, no person was actually found using the specified email address, but we want to return TLS info about the email address regardless. DEPRECATED: Use is_placeholder instead. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | boolean |
| youtubeExtendedData | For use with Youtube extension. | AppsPeopleOzExternalMergedpeopleapiPersonExtendedData | Extension data for the whole person entity. | AppsPeopleOzExternalMergedpeopleapiYoutubeExtendedData |
| aclChoices | When the container is PROFILE/DOMAIN_PROFILE and the profile owner is the requester, this read-only, synthesized field indicates which ACLs the user is allowed to set on the profile field. This is distinct from field_acl, which is the field’s currently set ACL. field_acl will always be a valid ACL choice, except for the case of default synthesized profile fields like monogram profile photos. For those, field_acl does not represent a user-set field ACL, so it may or may not be a valid choice. In all cases, default_acl_choice will always be a valid choice. This is currently only populated on the photo field when the “person.photo.metadata.acl_choices” mask is set. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiFieldAcl) |
| additionalContainerInfo | Additional information about the container of this field. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | AppsPeopleOzExternalMergedpeopleapiAdditionalContainerInfo |
| affinity | For field-level affinity scores. The affinity between the requester and this particular field in the Person (e.g., frequency of calling a particular phone number). | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiAffinity) |
| contactVisibility | Each field can have different visibility settings Only returned when explicitly requested. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(String) |
| container | DEPRECATED. Use container_type instead. Having the Container be an enum at the PFM message level causes circular dependency when other types try to refer to it. It breaks javascript build targets. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| containerId | DEPRECATED. Use encoded_container_id instead. The numeric id of the data source. The id is only unique within a single container type. This is only set when the id of the container is numeric, e.g. contact id. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| containerPrimary | Indicates if this field is the primary field for the container and container_id. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| containerType | The source for the data in the field. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| crossDeviceAllowed | True if this field can be used on other devices than the one it originated from. Assigned by the server. Currently only used for device contacts. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| defaultAclChoice | When the container is PROFILE/DOMAIN_PROFILE and the profile owner is the requester, this read-only, synthesized field contains the default ACL choice. This can be used to select a preferred choice from acl_choices. Generally, default_acl_choice should only be preferred for default synthesized profile fields like monogram profile photos. Otherwise, the existing field_acl should be preferred. This is currently only populated on the photo field when the “person.photo.metadata.acl_choices” mask is set. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | AppsPeopleOzExternalMergedpeopleapiFieldAcl |
| deprecatedContactContainerId | DEPRECATED. Use container_id. Not populated or used at all. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| edgeKey | Field is an edge key for this person. Modifying it breaks the link between data sources. This is equivalent to edge_key_info having at least one entry with materialized = true. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| edgeKeyInfo | Edges that this field creates. This includes all edges and not necessarily just the edge relevant to the joined entities. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo) |
| encodedContainerId | The encoded id of the data source. The id is only unique within a single container type. This field correlates to person.metadata.identity_info.source_id.id. This field may not be populated in some special cases, where the id is not visible to the querying user. e.g. ListAutocompletions with full phone number query. For value format, see google3/social/graph/api/proto/main_merged_person.proto?q=symbol:SourceIdentity.id | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| fieldAcl | When the container is PROFILE and the profile owner is the requester, this field indicates how the profile field is accessible. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | AppsPeopleOzExternalMergedpeopleapiFieldAcl |
| lastUpdateTime | Indicates the time that the field was added or last edited. Currently this is populated for: (1) person.birthday with ContainerType PROFILE, DOMAIN_PROFILE or ACCOUNT. (2) person.name, person.address, person.relation, person.email and person.phone with ContainerType CONTACT_ANNOTATION; | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | DateTime |
| matchingInfo | The matching informations if there was a query against this field. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiMatchInfo) |
| otherDedupedContainers | When deduping fields by value, list of containers of the fields that where deduped. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiDedupedContainerInfo) |
| primary | If true, indicates this field is the Person’s primary field eg. Contact, and (Profile) Person could have different Name fields, and the Name represented by the Person is primary. For selecting a primary field from RepeatedFields within a Person, use container_primary. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| productMetadata | The product(s) that generated the data in this field. Empty is equivalent to DEFAULT. ST_USER_METADATA | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | list(AppsPeopleOzExternalMergedpeopleapiProductMetadata) |
| verified | Indicates whether this is a verified field. It is synthesized from verification and is read-only. If there is at least one verification with status PASSED, the field is considered verified. Currently this is applicable to address, email, name, and phone for PROFILE and DOMAIN_PROFILE. Use .metadata.verified in the request mask. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| visibility | Currently, only people.get may set this value | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | String |
| writeable | Whether the field is writeable to the requester. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | Metadata for a single Person field. See go/understanding-merged-person | boolean |
| people | AppsPeopleOzExternalMergedpeopleapiPersonListWithTotalNumber | A person list with total number specified. | list(AppsPeopleOzExternalMergedpeopleapiPerson) | |
| totalNumber | The total number of people, which is aways no less than the size of the above list. | AppsPeopleOzExternalMergedpeopleapiPersonListWithTotalNumber | A person list with total number specified. | integer |
| affinity | Affinities associated with the person, with respect to the requester. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(AppsPeopleOzExternalMergedpeopleapiAffinity) |
| attribution | Populated when the data for the MergedPerson comes from a 3rd party provider or data source. Clients must display these attributions to the user if they are present. NOTE: This field is only relevant when requesting the following containers: – PLACE (data read from Maps) | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| bestDisplayName | The best name to use for this person for user-facing display. See go/people-api-howto:names for details about how this field is computed. In many cases this will simply be Person.name[0]. However, Person.name returns only explicit Name fields, but other fields maybe usable as a name (for example: nicknames, file_as, …). `best_display_name` will be calculated from all fields in storage which are usable as a name, even fields which are not explicitly requested in the MergedPerson result. See go/javagoog/apps/tacotown/socialgraph/entity/PersonNameFormatter.java | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | AppsPeopleOzExternalMergedpeopleapiBestDisplayName |
| blockType | DEPRECATED. Indicates whether the profile owner has blocked this person. Please use `person.read_only_profile_info.block_type` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| circleId | DEPRECATED. The circles the person belongs to. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| contactGroupId | DEPRECATED. Please use `person.contact_group_memberships` instead. The contact groups the person belongs to. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| contactId | The IDs of all contacts contributing to this person. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| customResponseMaskingType | DEPRECATED. Customized masking of the response similar to the legacy People2RequestMask People2Params request message. NOTE: This param is inherently client-specific, limited to specific legacy clients, and not open to new usage. NOTE: Effects may be applied to a subset of people in the response. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| deleted | For sync requests (i.e., changed since the provided sync_token), indicates the resource is a tombstone for a Person resource that has been entirely deleted. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | boolean |
| deprecatedBlocked | DEPRECATED. Please use `person.read_only_profile_info.block_type` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | boolean |
| deprecatedMembershipCircleId | DEPRECATED. This field is no longer populated or read. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| deprecatedMembershipContactGroupId | DEPRECATED. This field is no longer populated or read. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| deviceContactInfo | Info about the aggregated device contacts. When the person contains RAW_DEVICE_CONTACT containers, each DeviceContactInfo represents a single aggregate device contact made up of one or more raw device contacts. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(AppsPeopleOzExternalMergedpeopleapiDeviceContactInfo) |
| identityInfo | Detailed metadata about the lookup IDs and data sources included in a MergedPerson result. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | AppsPeopleOzExternalMergedpeopleapiIdentityInfo |
| inViewerDomain | DEPRECATED. Indicates whether this person is in the same domain as the viewer. For proxying trust between two users based on organization membership, see: – go/flex-orgs-platform – go/flex-orgs-compliance-handbook (especially http://shortn/_ChwfAY36Ys) | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | boolean |
| incomingBlockType | DEPRECATED. Indicates whether this person is blocking the profile owner. Please use `person.read_only_profile_info.incoming_block_type` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| lastUpdateTimeMicros | DEPRECATED. The last update timestamps for the constituent components of this person are available in `identity_info.source_ids`. The time of the most recent change to this person, in !!!NANOS!!! (due to a bug). May be a change to any of the underlying parts of the person (profile, contact, etc.). Not guaranteed to be the timestamp of the most recent change, due to limitations in the backend. This field is not fully deprecated for backend container-specific storage services like ProfileService which lack identity_info. The use is still discouraged in such systems and they should prefer to use the `last_update_time` field of this message instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| model | The person model that is used to construct this person. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| objectType | DEPRECATED. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| ownerId | DEPRECATED. Please use `person.read_only_profile_info.owner_id` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| ownerUserType | DEPRECATED. See `person.read_only_profile_info.owner_user_type` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| plusPageType | DEPRECATED. Please use `Person.plus_page_info` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | String |
| previousPersonId | DEPRECATED. This field is no longer populated or read. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | list(String) |
| profileOwnerStats | DEPRECATED. Stats/counters pertaining to followers and incoming edges. Please use `person.read_only_profile_info.profile_owner_stats` instead. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | AppsPeopleOzExternalMergedpeopleapiProfileOwnerStats |
| scoringInfo | Contact people-directory-dev-team@ if you want to use this field. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfo |
| userVisibleStats | DEPRECATED. This field is no longer populated or read. | AppsPeopleOzExternalMergedpeopleapiPersonMetadata | Metadata for the entire Person resource. | AppsPeopleOzExternalMergedpeopleapiUserVisibleStats |
| rawMatchQualityScore | Only populated on a SearchDirectoryPeople call, when results are scored. Contact people-directory-dev-team@ if you want to use this field. | AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfo | float | |
| stExpressionResults | 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. | AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfo | list(AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfoStExpressionResult) | |
| name | AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfoStExpressionResult | String | ||
| value | AppsPeopleOzExternalMergedpeopleapiPersonMetadataScoringInfoStExpressionResult | String | ||
| canonicalizedForm | Canonicalized form that follows ITU-T E.164 international public telecommunication numbering plan. | AppsPeopleOzExternalMergedpeopleapiPhone | String | |
| emergencyInfo | Emergency information. See go/emergency-trusted-contacts-papi. | AppsPeopleOzExternalMergedpeopleapiPhone | AppsPeopleOzExternalMergedpeopleapiFieldEmergencyInfo | |
| extendedData | Read-only. Field requested by specifying `HANGOUTS_PHONE_DATA` in `extension_set.extension_names`. | AppsPeopleOzExternalMergedpeopleapiPhone | AppsPeopleOzExternalMergedpeopleapiPhoneExtendedData | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiPhone | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPhone | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| type | 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` | AppsPeopleOzExternalMergedpeopleapiPhone | String | |
| uri | AppsPeopleOzExternalMergedpeopleapiPhone | String | ||
| value | AppsPeopleOzExternalMergedpeopleapiPhone | String | ||
| structuredPhone | For use with Hangouts extension. | AppsPeopleOzExternalMergedpeopleapiPhoneExtendedData | AppsPeopleOzExternalMergedpeopleapiStructuredPhone | |
| decoration | 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. | AppsPeopleOzExternalMergedpeopleapiPhoto | list(SocialGraphApiProtoDecorationOverlay) | |
| emojiAvatarUrl | 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 the `Photo.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 from `Photo.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 PersonFieldMetadata `container_type` for the Photo is NAMED_CHAT_ROOM – The chat room has an emoji type avatar image set | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| glyph | 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 PersonFieldMetadata `container_type` for the Photo is NAMED_CHAT_ROOM – The chat room has an emoji type avatar image set | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| htmlAttribution | 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-requirements | AppsPeopleOzExternalMergedpeopleapiPhoto | list(String) | |
| isDefault | True when the photo is synthetic or generated (i.e. a monogram or default photo), false when the person has a custom photo. | AppsPeopleOzExternalMergedpeopleapiPhoto | boolean | |
| isMonogram | 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. | AppsPeopleOzExternalMergedpeopleapiPhoto | boolean | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPhoto | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| monogramBackground | When is_monogram=true, this is the background color of the monogram photo as a hex RGB formatted string “RRGGBB”. | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| originalPhoto | 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. | AppsPeopleOzExternalMergedpeopleapiPhoto | SocialGraphApiProtoImageReference | |
| photoId | For writes only. Indicates photo content for person photo-field update. Currently only used for profile-photo updates (not contact photos yet). | AppsPeopleOzExternalMergedpeopleapiPhoto | AppsPeopleOzExternalMergedpeopleapiPhotoPhotoStorageId | |
| photoToken | Most clients don’t need to worry about this field and should just use the `url` 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. | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| url | See go/people-api-concepts/photos for info on the different representations of URLs. | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| viewerUrl | 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. | AppsPeopleOzExternalMergedpeopleapiPhoto | String | |
| mediaKey | For writes only, pass the media key that represents the image in photos backend. Note, this is not populated on reads. | AppsPeopleOzExternalMergedpeopleapiPhotoPhotoStorageId | Info necessary for looking up a photo in storage. | String |
| googleUrl | A URL hosted by Google providing more information about this place This is the URL returned by Places API in the Place.Url.google field | AppsPeopleOzExternalMergedpeopleapiPlaceDetails | Metadata specific to places. | String |
| latLng | AppsPeopleOzExternalMergedpeopleapiPlaceDetails | Metadata specific to places. | AppsPeopleOzExternalMergedpeopleapiLatLng | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPlaceDetails | Metadata specific to places. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| openingHours | AppsPeopleOzExternalMergedpeopleapiPlaceDetails | Metadata specific to places. | AppsPeopleOzExternalMergedpeopleapiOpeningHours | |
| primaryTypeName | The name of the primary type. Examples of primary type are: “art_school”, “clothing_wholesaler”, etc. All primary types can be found at http://shortn/_veqh6UwWdc | AppsPeopleOzExternalMergedpeopleapiPlaceDetails | Metadata specific to places. | String |
| achievements | User’s top achievements that are sorted for example by rarity. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | list(AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedDataAchievement) |
| avatarImageUrl | The avatar image to display for the user. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | String |
| failure | Failure type if there is an error when fetching product profile data. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | AppsPeopleOzExternalMergedpeopleapiProductProfileFailure |
| gamerTag | The gamer tag set by the user. Not set if the user hasn’t set a gamer tag yet. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | String |
| playerLevel | User’s level. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | integer |
| profileVisibility | Specifies the visibility of the player’s profile. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | String |
| totalFriendsCount | Total number of friends. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | String |
| totalUnlockedAchievements | How many achievements this player has unlocked. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedData | Extension data for use in Play Games Product Profile. See go/jam-games-profile. | String |
| achievementName | The name of the achievement. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedDataAchievement | Details of an achievement that the user has unlocked. | String |
| achievementUnlockedIconUrl | The achievement icon url shown to the user if it is unlocked. | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedDataAchievement | Details of an achievement that the user has unlocked. | String |
| rarityPercentage | Rarity of unlocking this achievement (3% of players unlocked would be 3) | AppsPeopleOzExternalMergedpeopleapiPlayGamesExtendedDataAchievement | Details of an achievement that the user has unlocked. | number |
| applicationId | Int64 ID of packaging-service entry; if set, the plus page is associated with a third-party application. | AppsPeopleOzExternalMergedpeopleapiPlusPageInfo | Information about a plus page and the entity it represents. | String |
| entityType | AppsPeopleOzExternalMergedpeopleapiPlusPageInfo | Information about a plus page and the entity it represents. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPlusPageInfo | Information about a plus page and the entity it represents. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| bounds | AppsPeopleOzExternalMergedpeopleapiPointSpec | Map marker location for an address. | GeostoreRectProto | |
| point | AppsPeopleOzExternalMergedpeopleapiPointSpec | Map marker location for an address. | GeostorePointProto | |
| pointSource | AppsPeopleOzExternalMergedpeopleapiPointSpec | Map marker location for an address. | String | |
| accountId | The user visible value is used to distinguish identical posix account fields with different customer key values. | 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. | String |
| accountNamespace | Value indicates the uniqueness namespace that applies to the POSIX information. The value is included in all POSIX account uniqueness indices. The indexing prevents two accounts within the same customer from having the same username. Namespacing allows Windows and Linux users to share the same username. | 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. | String |
| accountType | Value indicates whether the POSIX information is associated with a non-human entity and the validation logic to apply during PosixAccount mutation. | 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. | String |
| customerKey | The customer associated with the POSIX identity. If the user is already associated with a G Suite Customer, this field has the same value as http://google3/ccc/hosted/policies/settings/dthree_customer_info.proto | 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. | String |
| fingerprint | The value is automatically set to a SHA-256 fingerprint of the POSIX account. A fingerprint should uniquely identify a POSIX account entry. | 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. | String |
| gecos | The GECOS (user information) entry for this account. | 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. | String |
| gid | The default group ID. | 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. | String |
| homeDirectory | The path to the home directory for this account. | 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. | String |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| operatingSystemType | Value indicates whether to use Linux or Windows specific validation logic during PosixAccount mutation. | 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. | String |
| shell | The path to the login shell for this account. | 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. | String |
| systemId | System identifier for which account Username or Uid apply to. If not specified on mutate by a caller it will default to empty value if either Username or Uid are being set. SystemId does require to have a value (even an empty one) because it is included into null-filtered Spanner index used to enforce uniqueness on Username and Uid fields. | 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. | String |
| uid | The user ID. | 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. | String |
| username | The username of the account. | 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. | String |
| productSource | AppsPeopleOzExternalMergedpeopleapiProductMetadata | String | ||
| failureType | AppsPeopleOzExternalMergedpeopleapiProductProfileFailure | Product profiles failure type: the status of the rpc to fetch the product profile. | String | |
| incomingAnyCircleCount | Replacement for deprecated follower_count. Comes from the EdgeSummary. | 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. | String |
| viewCount | Deprecated. This field is no longer populated by the server. | 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. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiProfileUrl | This is a Google+-only field (and thus does not exist for consumer users). See go/fbs-g+-deprecation. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| url | AppsPeopleOzExternalMergedpeopleapiProfileUrl | This is a Google+-only field (and thus does not exist for consumer users). See go/fbs-g+-deprecation. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiPronoun | Message to represent a user’s set of preferred pronouns, see go/pronouns-backend. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| pronounData | AppsPeopleOzExternalMergedpeopleapiPronoun | Message to represent a user’s set of preferred pronouns, see go/pronouns-backend. | SocialGraphApiProtoPronounData | |
| dataSet | The data set within the account that this raw contact belongs to. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactAnalyticalInfo | String | |
| dirty | 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 synced | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactAnalyticalInfo | boolean | |
| sourceIdExist | Whether the source ID exists for non-Google contacts. Won’t set for Google contacts. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactAnalyticalInfo | boolean | |
| syncInfo | The Sync Info of a raw contact. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactAnalyticalInfo | SocialGraphApiProtoSyncInfo | |
| accountName | Account name of raw contact, e.g. “[email protected]”. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| accountType | Account type of raw contact, e.g. “com.google” or “com.linkedin.android”. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| appContactData | The detailed app-specific endpoint data available for the given RawDeviceContactInfo instance. This proto should be used to obtain the list of actions and mimetypes supported by the third-party app. Design: go/3p-contact-upload | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | list(SocialGraphApiAppContactData) |
| appInfo | The app-specific endpoint data needed for app action fulfillment. Usage of this field should be avoided on the server-side, and should use the more detailed |full_app_info| field. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo |
| crossDeviceAllowed | If true, this raw contact can be used on other devices than the one it originated from. Assigned by the server. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | boolean |
| deviceContactMetadata | Extra metadata for this raw contact. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | AppsPeopleOzExternalMergedpeopleapiDeviceContactExtraMetadata |
| googleContactId | The focus contact id for Google contacts. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| id | The base64 serialized social.graph.peopleapi.proto.internal.RawDeviceContactId. This id should be used to correlate to field.metadata.encoded_container_id when the field.metadata.container_type is RAW_DEVICE_CONTACT The id also correlates to person.metadata.identity_info.source_id.id. For value format, see google3/social/graph/api/proto/main_merged_person.proto?q=symbol:SourceIdentity.id | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| photoType | The type of photo from the device (if any). | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| rawContactId | The id of the raw contact on the device. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | String |
| rawDeviceContactAnalyticalInfo | Only to be used by Romanesco team specifically for analytics. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo | Raw device contact information. | AppsPeopleOzExternalMergedpeopleapiRawDeviceContactAnalyticalInfo |
| accountEmail | The account email linked to the profile, if any exists and is visible to the requester. | 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). | AppsPeopleOzExternalMergedpeopleapiAccountEmail |
| blockType | Indicates whether the profile owner has blocked this person. | 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). | list(String) |
| customerInfo | CustomerInfo for dasher user. The reader has to explicitly request this in the field_mask as ‘read_only_profile_info.customer_info’ | 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). | AppsPeopleOzExternalMergedpeopleapiCustomerInfo |
| domainInfo | DEPRECATED. Use the `ReadOnlyProfileInfo.customer_info` field instead (b/138120418). Only populated if in_viewer_domain is true. | 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). | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfoDomainInfo |
| inViewerDomain | DEPRECATED. Proxying trust between users in a domain should use go/flex-orgs-platform. For more info see: http://doc/18i0-C7vWcz2UuXYBsmulnriVCK3_EuMPpRlPa2OmMHw#heading=h.dobotdwx25kg Indicates whether the profile owner is in the same domain as the viewer. | 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). | boolean |
| incomingBlockType | Indicates whether this person is blocking the profile owner. | 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). | list(String) |
| metadata | 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). | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| objectType | DEPRECATED. | 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). | String |
| ownerId | The Focus-obfuscated Gaia ID of the profile owner (go/obfuscated-ids). | 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). | String |
| ownerUserType | 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). | list(String) | |
| plusPageType | DEPRECATED. Please use `person.plus_page_info` instead. | 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). | String |
| profileOwnerStats | Stats/counters pertaining to followers and incoming edges. | 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). | AppsPeopleOzExternalMergedpeopleapiProfileOwnerStats |
| unjoinedEmailCertificates | Returned only when explicitly requested in the request mask as read_only_profile_info.unjoined_email_certificates. Equivalent to fetching the Emails & the Email Certificates with the acls ignored. | 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). | list(AppsPeopleOzExternalMergedpeopleapiEmail) |
| domainBadge | DEPRECATED. Organization badge for the domain this person is a member of. The badge is the primary hosted domain. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfoDomainInfo | DEPRECATED. | list(String) |
| domainName | DEPRECATED. Hosted domain this person is a member of. Formerly only available via PersonExtendedData. | AppsPeopleOzExternalMergedpeopleapiReadOnlyProfileInfoDomainInfo | DEPRECATED. | list(String) |
| canonicalValue | Canonicalized `value` of the relation from this person to the user. This is currently used for data from contact annotations. Possible canonical values are based from http://google3/googledata/quality/aliases/relationship_en.config. | 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. | String |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | 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. | String |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| relationDetails | The person whose email matches the Relation.value field, if it is a valid email address. This field is read-only and ignored on update. | 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. | AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails |
| type | The relation type. The type can be free form or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner` | 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. | String |
| value | The person this relation applies to. Custom value provided by the user. | 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. | String |
| displayName | Equivalent to Name.display_name for the person_id profile. | AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails | String | |
| jobTitle | Equivalent to Organization.title for the primary organization of the person_id profile. | AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails | String | |
| personId | AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails | String | ||
| photoUrl | Equivalent to Photo.url for the person_id profile. | AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails | String | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiRelationshipInterest | Deprecated in b/122464133. No data returned for this field. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiRelationshipInterest | Deprecated in b/122464133. No data returned for this field. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | These fields may give away the sexual orientation of the user. | AppsPeopleOzExternalMergedpeopleapiRelationshipInterest | Deprecated in b/122464133. No data returned for this field. | String |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiRelationshipStatus | Deprecated in b/122464133. No data returned for this field. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiRelationshipStatus | Deprecated in b/122464133. No data returned for this field. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | AppsPeopleOzExternalMergedpeopleapiRelationshipStatus | Deprecated in b/122464133. No data returned for this field. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiRightOfPublicityState | User preference for shared endorsements. See go/se-devguide and go/sharedendorsements for details, including guidance on which contexts are which. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| state | AppsPeopleOzExternalMergedpeopleapiRightOfPublicityState | User preference for shared endorsements. See go/se-devguide and go/sharedendorsements for details, including guidance on which contexts are which. | String | |
| abridgedRosterMemberships | Abridged / sample subset of member details of the roster. NOTE: This field is only returned if the request’s field mask includes “person.roster_details.abridged_roster_memberships”. http://cs/symbol:google.apps.cloudidentity.groups.internal.GroupSummary.abridged_memberships | AppsPeopleOzExternalMergedpeopleapiRosterDetails | Information specific to rosters like Google Groups and Chatrooms. | list(AppsPeopleOzExternalMergedpeopleapiRosterMember) |
| metadata | AppsPeopleOzExternalMergedpeopleapiRosterDetails | Information specific to rosters like Google Groups and Chatrooms. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| rosterMemberCount | Indicates the number of members and sub-rosters of the roster. Corresponds to http://cs/symbol:google.apps.cloudidentity.groups.internal.Group.direct_member_count_per_type | AppsPeopleOzExternalMergedpeopleapiRosterDetails | Information specific to rosters like Google Groups and Chatrooms. | AppsPeopleOzExternalMergedpeopleapiRosterMemberCount |
| memberType | Type of the member. | AppsPeopleOzExternalMergedpeopleapiRosterMember | Represents details of a member of a roster. Used in RosterDetails. Corresponds to http://cs/symbol:google.apps.cloudidentity.groups.internal.Membership | String |
| personId | Focus-Obfuscated Gaia Id of the member. | AppsPeopleOzExternalMergedpeopleapiRosterMember | Represents details of a member of a roster. Used in RosterDetails. Corresponds to http://cs/symbol:google.apps.cloudidentity.groups.internal.Membership | String |
| directGroupCount | Indicates the number of direct sub-rosters of the roster. This comes from http://cs/symbol:google.apps.cloudidentity.groups.internal.Group.DirectMemberCountPerType.group_count | 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 | String |
| directUserCount | Indicates the number of direct, non-roster members of the roster. This comes from http://cs/symbol:google.apps.cloudidentity.groups.internal.Group.DirectMemberCountPerType.user_count | 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 | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiSearchProfile | Profile for Janata and Search. go/janata-profile-in-sgbe | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| searchProfileData | AppsPeopleOzExternalMergedpeopleapiSearchProfile | Profile for Janata and Search. go/janata-profile-in-sgbe | SocialGraphApiProtoSearchProfileData | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiSipAddress | As of 03/2018 is not supported for user Profile. | String |
| metadata | AppsPeopleOzExternalMergedpeopleapiSipAddress | As of 03/2018 is not supported for user Profile. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | The type of the SIP address. The type can be free form or or one of these predefined values: * `home` * `work` * `mobile` * `other` | AppsPeopleOzExternalMergedpeopleapiSipAddress | As of 03/2018 is not supported for user Profile. | String |
| value | AppsPeopleOzExternalMergedpeopleapiSipAddress | As of 03/2018 is not supported for user Profile. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiSkills | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiSkills | String | ||
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| type | 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. | list(String) | |
| affinity | AppsPeopleOzExternalMergedpeopleapiSortKeys | list(AppsPeopleOzExternalMergedpeopleapiAffinity) | ||
| interactionRank | Deprecated. This field is only populated with 0.000 for legacy reasons. Clients should not use this field. | AppsPeopleOzExternalMergedpeopleapiSortKeys | String | |
| lastName | AppsPeopleOzExternalMergedpeopleapiSortKeys | String | ||
| lastNameRaw | AppsPeopleOzExternalMergedpeopleapiSortKeys | String | ||
| name | AppsPeopleOzExternalMergedpeopleapiSortKeys | String | ||
| nameRaw | 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). | AppsPeopleOzExternalMergedpeopleapiSortKeys | String | |
| container | The type of source. To be deprecated infavor of container_type | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | String |
| containerType | The type of the source. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | String |
| deleted | In sync responses, indicates whether the identity source has been deleted. Not applicable to GOOGLE_GROUP. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | boolean |
| id | The encoded id of the data source. This field correlates to PersonFieldMetadata.encoded_container_id. The possible values of this `id` field are as follows based on the value of the `container_type` field: CONTACT: Hex-encoded contact id. PROFILE: DOMAIN_PROFILE: GOOGLE_GROUP: NAMED_CHAT_ROOM: Focus-obfuscated Gaia ID. DOMAIN_CONTACT: Synthetic-contact id representing the domain shared contact. PLACE: Encoded PlaceId (go/javagoog/maps/api/places/util/PlaceIdEncoder.java) RAW_DEVICE_CONTACT: Pair of device_id and raw_contact_id, encoded as base64 serialized social.graph.peopleapi.proto.internal.RawDeviceContactId proto. CONTACT_ANNOTATION: Pair of annotation_id and event_timestamp, encoded as base64 serialized social.graph.peopleapi.proto.internal.ContactAnnotationId proto. — DEPRECATED container types — If the container is CIRCLE, then the id is going to be the synthetic- contact id representing the email-only circle member or gaia circle member for which the requester does not have a contact for. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | String |
| lastUpdated | Last update timestamp of this source. NOTE: Only populated for CONTACT container type in Java PeopleAPI. Populated for CONTACT, PROFILE, DOMAIN_PROFILE in Sharpen implementation. NOTE: Not populated for GOOGLE_GROUP. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | DateTime |
| lastUpdatedMicros | **DEPRECATED** Please use `last_updated` field instead. Last update timestamp of this source in microseconds. NOTE: Only populated for CONTACT container type. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | String |
| sourceEtag | NOTE: Not populated for GOOGLE_GROUP. | AppsPeopleOzExternalMergedpeopleapiSourceIdentity | Id of a single source from the merged person. | String |
| expirationTime | 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. | DateTime | |
| fingerprint | The value is automatically set to a SHA-256 fingerprint of an SSH public key. A fingerprint should uniquely identify an SSH public key. | 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. | String |
| key | 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. | String | |
| metadata | 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. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| formattedType | The phone formatted type. See docs from mirrored proto: http://google3/ccc/grand_central/common/types.proto?l=128&rcl=241000760 | 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. | String |
| phoneNumber | 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. | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumber | |
| shortCode | 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. | AppsPeopleOzExternalMergedpeopleapiStructuredPhoneShortCode | |
| type | The type of phone. See docs from mirrored proto: http://google3/ccc/grand_central/common/types.proto?l=125&rcl=241000760 | 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. | String |
| e164 | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumber | String | ||
| i18nData | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumber | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | ||
| countryCode | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | integer | ||
| internationalNumber | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | String | ||
| isValid | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | boolean | ||
| nationalNumber | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | String | ||
| regionCode | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | String | ||
| validationResult | AppsPeopleOzExternalMergedpeopleapiStructuredPhonePhoneNumberI18nData | String | ||
| code | The phone code. See docs from mirrored proto: http://google3/ccc/grand_central/common/types.proto?l=70&rcl=241000760 | AppsPeopleOzExternalMergedpeopleapiStructuredPhoneShortCode | String | |
| countryCode | AppsPeopleOzExternalMergedpeopleapiStructuredPhoneShortCode | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiTagline | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiTagline | String | ||
| adminTo | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | list(AppsPeopleOzExternalMergedpeopleapiPerson) | |
| admins | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | list(AppsPeopleOzExternalMergedpeopleapiPerson) | |
| dottedLineManagers | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | list(AppsPeopleOzExternalMergedpeopleapiPerson) | |
| dottedLineReports | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | AppsPeopleOzExternalMergedpeopleapiPersonListWithTotalNumber | |
| failures | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | list(String) | |
| managementChain | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | list(AppsPeopleOzExternalMergedpeopleapiPerson) | |
| reports | AppsPeopleOzExternalMergedpeopleapiTeamsExtendedData | *UNSUPPORTED*. This message is never populated and is no longer used. | AppsPeopleOzExternalMergedpeopleapiPersonListWithTotalNumber | |
| key | AppsPeopleOzExternalMergedpeopleapiUserDefined | String | ||
| metadata | AppsPeopleOzExternalMergedpeopleapiUserDefined | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| value | AppsPeopleOzExternalMergedpeopleapiUserDefined | String | ||
| incomingAnyCircleCount | Replacement for deprecated follower_count. Comes from the EdgeSummary. | 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. | String |
| viewCount | 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. | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiVisibleToGuests | Store metadata information like annotation-id and product source for visible to guests contacts go/visible-to-guests. | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | |
| isIncomplete | Used by Contacts client-side to indicate whether a person is not completed. | AppsPeopleOzExternalMergedpeopleapiWebContactsExtendedData | boolean | |
| formattedType | The `type` translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage. | AppsPeopleOzExternalMergedpeopleapiWebsite | String | |
| metadata | AppsPeopleOzExternalMergedpeopleapiWebsite | AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata | ||
| rel | 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. | AppsPeopleOzExternalMergedpeopleapiWebsite | list(AppsPeopleOzExternalMergedpeopleapiWebsiteRelationshipInfo) | |
| type | 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` | AppsPeopleOzExternalMergedpeopleapiWebsite | String | |
| value | AppsPeopleOzExternalMergedpeopleapiWebsite | String | ||
| type | AppsPeopleOzExternalMergedpeopleapiWebsiteRelationshipInfo | String | ||
| channelData | Information about a channel created by the user. A user can create multiple Youtube channels. | AppsPeopleOzExternalMergedpeopleapiYoutubeExtendedData | Extension data for use in Youtube Product Profile. | list(AppsPeopleOzExternalMergedpeopleapiChannelData) |
| failure | Failure type if there is an error when fetching product profile data. | AppsPeopleOzExternalMergedpeopleapiYoutubeExtendedData | Extension data for use in Youtube Product Profile. | AppsPeopleOzExternalMergedpeopleapiProductProfileFailure |
| expressUrlInSettingsResponseSupported | This flag is used to work around a bug in AGSA 6.8 that got away. The bug prevents users from accessing their shopping list if the URL of the shopping list is not a keep.google.com URL. This will happen when switch the backend that stores the shopping list from Keep to a backend maintained by the Google Shopping Express team. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| reconnectClientInputSupported | Whether client supports reconnect client input in action v2 payload. This capability is needed to determine if client supports parsing client input payload from actionv2 proto for workflow purposes. See go/personal-workflow. OWNER:nyzstar,vvvemuri. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| simpleActionV2PuntSupported | Whether or not the surface supports a simple UnsupportedAction instead of a ModalState punt card for rendering. For ActionV2 punt cards, the ModalState extension on the ResourceSet is the canonical way of building punt cards. However, while most all devices support the ActionV2 protocol, not all devices handle the ModalState rendering as part of the ActionV2. For these devices, we want to build a modified ActionV2 for punt cards which omits this ModalState. At present, this is only Android Wear and should not be used for other devices if they support ModalState or Conversation protocol. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| supportedActionType | A list of all the action types supported by the client. These should be the string representation of majel.ActionTypes within “quality/majel/api/proto/action_v2.proto”. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | list(String) |
| takeScreenshotSupported | Checks if screenshots can be taken on the client. This field is set on the client from AGSA 7.2 onwards. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| voiceDelightImmersiveUiSupported | If IMMERSIVE_ACTIONS UiType is supported by the client. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| voiceDelightStickersSupported | If Voice Delight Stickers are supported by the client. In order to support Voice Delight stickers, the client should know how to extract sticker_url from VoiceDelightSystemInteractionSegment. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| voiceDelightSuggestionsSupported | If Voice Delight Suggestion Chips are supported by the client. In order to support Voice Delight Suggestion Chips, the client should know how to extract suggestions form VoiceDelightSystemInteraction.ResourceSet. | AssistantApiActionV2SupportedFeatures | The features supported by the ActionV2 protocol. Note that after we move on to ConversationProto for all surfaces we can remove this message. | boolean |
| androidIntentCapability | 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. | list(AssistantApiAndroidIntentCapabilitiesAndroidIntentCapability) | |
| intentActionName | The Action name of the Android Intent in standard notation (https://developer.android.com/reference/android/content/Intent#getAction()). | AssistantApiAndroidIntentCapabilitiesAndroidIntentCapability | String | |
| packageNames | The Android provider packages that support the intent, e.g. “com.google.android.deskclock”. | AssistantApiAndroidIntentCapabilitiesAndroidIntentCapability | list(String) | |
| allowlistedForMediaFulfillment | Indicates whether the provider is compatible for media fulfillment on this surface. For example, Amazon Music isn’t compatible with the driving mode. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| appIntegrationsSettings | Currently unused. Will be used in the future when integrating with incremental app capabilities. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | AssistantApiAppIntegrationsSettings |
| disabledSystemApp | This system app is disabled in settings. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| provider | The installed app of the provider. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | AssistantApiCoreTypesProvider |
| routableToProviderCloud | This provider has integrated its cloud backend with Google, and Google can route the user queries to the provider’s cloud. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| searchableOnDevice | This provider has an app that supports on-device search through the provider’s own inventory. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| searchableOnServer | This provider has integrated its content with Google, and Google has enabled to serve its content as a server-side solution. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| supports3pPodcastPlayback | Indicates whether the provider supports playback of 3P(externally hosted) podcasts. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| supportsScreenlessInitiation | This provider has an app that supports starting new media playback when there is no screen (e.g. by integrating with the Bisto SDK). | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| whitelistedForAnnotation | This provider is an app which should be used for query annotations. This is useful for apps which may not be already indexed by Google or are client specific. | AssistantApiAppCapabilities | Used to describe app capabilities of the device installed apps reported to the server. | boolean |
| appIntegrationsSettings | Currently unused. Will be used in the future when integrating with incremental app capabilities. | AssistantApiAppCapabilitiesDelta | Used to describe the incremental change of app capabilities of the device installed apps reported to the server. | AssistantApiAppIntegrationsSettings |
| providerDelta | The installed app of the provider. | AssistantApiAppCapabilitiesDelta | Used to describe the incremental change of app capabilities of the device installed apps reported to the server. | AssistantApiCoreTypesProviderDelta |
| enabled | AssistantApiAppControlSupport | String | ||
| sendMessageSuppressed | 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. | AssistantApiAppControlSupport | boolean | |
| handleRequestsWithPredictedApps | Whether to enable Assistant to handle request with predicted apps. | AssistantApiAppIntegrationsSettings | Contains the app privacy bits used for App Integrations implicit request. (go/app-privacy-settings-for-implicit-requests) | String |
| plateSupport | 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. | AssistantApiAssistantContinuedPresenceSupport | String | |
| environment | 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. | String | |
| quality | 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. | String | |
| alwaysOnSpeaker | 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. | String | |
| environment | 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. | String | |
| mediaTtsMixable | 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. | String | |
| quality | 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. | String | |
| volumeProperties | 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. | AssistantApiVolumeProperties | |
| isBluetoothConnectedProfileRequired | If this surface needs to bluetooth pair a phone before using a feature. | AssistantApiBluetoothCapabilities | Bluetooth capabilities related to usage of a feature. | boolean |
| callFormats | The supported call formats on the surface. | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | list(String) |
| callMediums | The supported call mediums on the surface. | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | list(String) |
| callOptions | The call options this surface can provide. For example, SPEAKERPHONE is available on Android OPA while iOPA doesn’t support it yet. | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | list(String) |
| fallbackToTetheredDeviceAppCapabilities | 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). | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | boolean |
| supportedRecipientTypes | Should only be checked if nonempty. | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | list(String) |
| supportsDuoEmailEndpoint | AssistantApiCallCapabilities | CallCapabilities supported by a surface. See go/call-capabilities. Next ID: 7 | boolean | |
| faceMatchCapable | Whether the device supports Face Match. | AssistantApiCameraCapabilities | These capabilities represent the camera features associated with the device. | boolean |
| hasCamera | Whether the device has a camera. | AssistantApiCameraCapabilities | These capabilities represent the camera features associated with the device. | boolean |
| hasLimitedCameraStreamCapability | Whether the device has limited camera stream capability. If true, check supported_camera_receivers for detailed supported cameras. | AssistantApiCameraReceiverCapabilities | These capabilities present the capability of the device running camera receiver apps. | boolean |
| supportedCameraReceivers | The camera receiver cast apps the device supports. Only used if has_limited_camera_stream_capability is true. | AssistantApiCameraReceiverCapabilities | These capabilities present the capability of the device running camera receiver apps. | list(AssistantApiCoreTypesCastAppInfo) |
| shouldPuntMultiAssistantMode | Indicates whether the current Assistant should provide a multi Assistant specific punt when there are multiple Auto specific Google Assistants (Android Auto Projected (AAP) and Android Auto Embedded (AAE)) in the same GAS enabled car. This will be used by both AAP and AAE. Design doc: go/doubledash++ | 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. | boolean |
| playWarmerWelcome | If true, it indicates that the auto surface client should receive a warmer welcome TTS for signed-out users. For signed-in user, we will rely on server side metadata. go/aaae:preview-lang | AssistantApiCarSettingsCapabilities | Capabilities that are associated with Assistant Settings on auto surfaces. | boolean |
| supportsAddingCars | If true, it indicates that the client can be used to add cars after account linking with the OEM. | AssistantApiCarSettingsCapabilities | Capabilities that are associated with Assistant Settings on auto surfaces. | boolean |
| castLinkingStatus | 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). | AssistantApiCastAssistantSettingLinkingResult | String | |
| truncatedErrorMsg | The error msg returned from COS, truncated in case it’s too large. | AssistantApiCastAssistantSettingLinkingResult | String | |
| cameraReceiverCapabilities | Whether the device has limited camera stream capability and if yes, which receivers are supported. | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | AssistantApiCameraReceiverCapabilities |
| cameraStreamSupportedProtocols | The supported protocols for camera streaming. The value is used as string in go/smarthome-internal-api#camera-stream, so using a string for this field instead of an enum. Supported protocols: (align the definition in go/smarthome-camerastream-trait) – “hls”: HTTP Live Streaming – “dash”: Dynamic Adaptive Streaming over HTTP – “smooth_stream”: Smooth Streaming – “progressive_mp4”: Progressive MP4 (will likely only be used for Clips) – “webrtc”: WebRTC (currently, only H.264 is supported) – “nexustalk”: Internal-only protocol used for Nest | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | list(String) |
| canReceiveCast | True if we can cast things to this device. | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | boolean |
| deviceId | Optional for primarily cast devices (e.g., Chirp, Chromecast). For devices that are NOT primarily cast devices, but having a cast receiver as secondary functionality, this field SHOULD store the cast-device-id to be used to send remote casting commands to the device. Example: Android TV, which supports both Android-native actions as well as remote casting using its built-in cast receiver. Android TV device id contains a DUSI id, which is not a cast-device-id. When executing a cast command on the Android TV, this field is used to route the cast command (through CloudCastService) to the cast receiver on the device. | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | AssistantApiCoreTypesDeviceId |
| dynamicGroupsSupported | Whether this device supports dynamic groups or not. It implies if a Stream Control operation (transfer, expansion, and contraction) could be applied on this device since Stream Control is implemented as part of dynamic groups (ie, adding/removing devices from playback) | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | boolean |
| groupType | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | String | |
| overlayApplicationsSupported | Whether UI overlay applications are supported on this device. It’s used by Chromecast only. | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | boolean |
| yetiGamingSupported | Whether the device supports playing games through Yeti. This is set by the cast device when the device is updated: Chromecast updates -> Chromecast registers its capabilities with CCS -> CCS passes the capabilities to the AssistantSettingsService -> AssistantSettingsService stores the device’s capabilities. go/yeti-gaming-supported-cast-capability | AssistantApiCastCapabilities | These capabilities represent capabilities that have to do with casting that pertain to this device. Next ID: 9 | boolean |
| skipAndroidAndGsaVersionCheck | Additional specific setting capabilities. This boolean is used to indicate whether we want to skip the Android and GSA version check in CheckSettingSchemaAndMaybeGetUris() from assistant/vertical/device/fulfillment/utils/setting_utils.h. Consider setting this field to true if your device is neither Android or GSA (especially when the UserAgent string of your device’s TaskRequest will not contain a valid/up-to-date Android/GSA version). | AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty | The properties of the client op device.MODIFY_SETTING. This proto is stored in the SupportedClientOp proto. | boolean |
| supportedSettings | Uses DeviceSetting enum which corresponds to setting_id. This indicates which specific settings are supported by client. An empty list implies all settings are supported. | AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty | The properties of the client op device.MODIFY_SETTING. This proto is stored in the SupportedClientOp proto. | list(String) |
| supportsDoNotDisturbWithDuration | Additional specific setting capabilities. This boolean is used to indicate if do not disturb with duration is supported through device.MODIFY_SETTING clientop on a client or not. | AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty | The properties of the client op device.MODIFY_SETTING. This proto is stored in the SupportedClientOp proto. | boolean |
| supportsMuteUnmute | Additional specific setting capabilities. This boolean is used to indicate if new unmute logic is enabled on a client or not. | AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty | The properties of the client op device.MODIFY_SETTING. This proto is stored in the SupportedClientOp proto. | boolean |
| keepsConversationAliveAfterOpeningApp | Whether conversation is kept alive after opening the app. See go/keep-opa-conversation-alive for details. | AssistantApiClientOpPropertiesProviderOpenClientOpProperty | The properties of the provider.OPEN ClientOp. This proto is stored in the SupportedClientOp proto with the key provider.OPEN. | boolean |
| maxSupportedAlarms | Maximum number of alarms that can be created on the client. | 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). | integer |
| maxSupportedExtendedTimerDuration | Maximum extended timer duration supported by the client. The extended timer duration is the total start-to-finish duration after an AddTimeToTimer operation. E.g. if a user sets a timer for 30 minutes, and later adds 10 minutes, the extended duration is 40 minutes. | 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). | AssistantApiDuration |
| maxSupportedTimerDuration | Maximum duration of timers that can be created on the client. | 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). | AssistantApiDuration |
| maxSupportedTimers | Maximum number of timers that can be created on the client. | 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). | integer |
| preferredStopwatchProvider | The preferred provider to use for stopwatch related functionality. | 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). | AssistantApiCoreTypesProvider |
| restrictAlarmsToNext24h | Whether the client restricts alarms to ring within the next 24 hours. | 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). | boolean |
| fluidActionsUiType | AssistantApiCommunicationUiCapabilities | UI capabilities for the surfaces rendering Comms features. See go/rohan-comms-fluid-actions-customization. | String | |
| fallbackToTetheredDevice | 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. | AssistantApiContactLookupCapabilities | boolean | |
| accountType | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String | |
| activityInfo | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | AssistantApiCoreTypesAndroidAppInfoActivityInfo | |
| androidIntent | Intent associated with the app. We include intents here as different versions of the same app may support different intents. In those cases, the package_name is not enough to identify the app and we should use the combination of package_name and android_intent. This field might contain sensitive data, if represents ClientOp with encapsulated PII such as user query. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| appUniqueId | Store the app unique id endpoint. This will be passed over to app to fulfill the action. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| appVersion | The android app version. Deprecated because https://developer.android.com/reference/android/content/pm/PackageInfo.html#getLongVersionCode | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | integer |
| dataMimetype | data_mimetype and account_type are the what AGSA uses to filter which contacts support this Android app in ContactProvider. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| isBroadcastIntent | If true, client should broadcast the intent instead of open the intent. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | boolean |
| isDefault | App is the default app for it’s core functionality. For example, it will be true for Android messages if it is the default app to send and receive SMS on the phone. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | boolean |
| localizedAppName | The localized app name. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| longVersionCode | The long android app version. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| mimetype | Store mimetype of this endpoint. We will use this as the differentiator for Assistant to know whether to use the RawContact for messaging, call or video call. For example, send message mimetype for whatsapp: “vnd.android.cursor.item/vnd.com.whatsapp.profile” voice call mimetype for whatsapp: “vnd.android.cursor.item/vnd.com.whatsapp.voip.call” | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| packageName | The android app package of the provider, like “com.spotify.music”. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| providerType | The OemProviderType is specific for OEM system Android apps. For example, in Auto Embedded, the OEM will have a system Radio/Media app. The system app’s capabilities/core functionalities are captured here. For physical media sources, the OEM may decide to implement one media app (thus, one package name) that handles multiple physical media sources. For these cases, each physical media source will be sent as different providers even though the package name is the same. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| shortcutId | Id of the app’s Android shortcut to be launched by Assistant. The client is expected to use the Android LauncherApps API to execute this shortcut which in turn will open the app. For example, Whatsapp may create an Android shortcut for a frequently messaged contact with an id “contact_123”. This field will contain that id and the client can execute it to open up the chat with that particular contact. If this field is set, the package_name field must also be set since both will be used by the LauncherApps API for execution. If this field is set, the intent related fields will be ignored and not used as a fallback. Design: go/shortcut-id-in-provider-open-clientop This field should only be set for devices with Android API level >= 25 (since that is the version from which the LauncherApps startShortcut API is available) | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| targetClass | The fully qualified target class name of the provider, like “com.example.myapp.GetOrderService”. | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| versionName | The android app version name, like “4.1.091.05.40d”, “11.2.7.21.alpha”. Android Docs: https://developer.android.com/reference/android/content/pm/PackageInfo#versionName | AssistantApiCoreTypesAndroidAppInfo | The android app information of the provider. Like, Spotify. Next ID: 17 | String |
| activeLaunchableActivities | Activities that are currently active and tagged as ACTION_MAIN and CATEGORY_LAUNCHER. Includes the activity corresponding to android_intent if it falls under CATEGORY_LAUNCHER. | AssistantApiCoreTypesAndroidAppInfoActivityInfo | General information about activities in the app. | list(AssistantApiCoreTypesAndroidAppInfoActivityInfoActivity) |
| localizedActivityName | The localized user visible activity name. | AssistantApiCoreTypesAndroidAppInfoActivityInfoActivity | Information about an individual activity. | String |
| shortClassName | Short class name for activity, following https://developer.android.com/reference/android/content/ComponentName#getShortClassName() | AssistantApiCoreTypesAndroidAppInfoActivityInfoActivity | Information about an individual activity. | String |
| androidAppInfo | The android app information of the provider. Like, Spotify. | AssistantApiCoreTypesAndroidAppInfoDelta | The change of AndroidAppInfo, e.g. app installation or deletion for incremental delta app info upload. | AssistantApiCoreTypesAndroidAppInfo |
| lastUpdateTimestamp | The client-side timestamp in millis when the app is last updated, installed or deleted. | AssistantApiCoreTypesAndroidAppInfoDelta | The change of AndroidAppInfo, e.g. app installation or deletion for incremental delta app info upload. | DateTime |
| updateType | App is installed or deleted. | AssistantApiCoreTypesAndroidAppInfoDelta | The change of AndroidAppInfo, e.g. app installation or deletion for incremental delta app info upload. | String |
| attendees | Attendees invited to the event, usually includes also the organizer. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | list(AssistantApiCoreTypesCalendarEventAttendee) |
| backgroundColor | The background color of the event, in RGB format. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | integer |
| calendarId | Optional calendar containing the event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| creator | The person who created this event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | AssistantApiCoreTypesCalendarEventAttendee |
| description | Optional description of the event (plain text). | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| end | The end time of the event. Start and end time must either both be date or both be datetime. End is exclusive, ie. the first day / first second when the event is over. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | AssistantApiDateTime |
| eventId | Optional event id provided by assistant server. Needs to be unique, at least on a per-user and calendar level, ideally globally unique. If none is given, the server will assign an id. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| flairName | The flair name, calculated according to the event title (go/as-cal-flair). With the flair name, background images can be got from gstatic (go/scs): https://ssl.gstatic.com/tmly/f8944938hffheth4ew890ht4i8/flairs/ | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| foregroundColor | The foreground color of the event, in RGB format. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | integer |
| guestsCanInviteOthers | Whether the guests can invite other guests. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | boolean |
| guestsCanModify | Whether the guests can modify the event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | boolean |
| guestsCanSeeGuests | Whether the guests of the event can be seen. If false, the user is reported as the only attendee to the event, even though there may be more attendees. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | boolean |
| habitId | Optional id of the Habit (Calendar Goal) this event is linked to | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| habitStatus | Optional status for this habit event instance. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| htmlLink | Absolute link to this event in the Calendar web UI. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| location | Optional location of the event (plain text). | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| meetingContacts | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | list(AssistantApiCoreTypesCalendarEventMeetingContact) | |
| organizer | The organizer of this event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | AssistantApiCoreTypesCalendarEventAttendee |
| otherAttendeesExcluded | Whether not all attendees are included in the attendee list. This is set when the attendees list has been truncated (e.g., when the number of attendees is beyond the maxAttendees limitation). | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | boolean |
| participationResponse | The user’s response (the owner of this copy of the event) to this event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| recurringEventId | If this is an instance of a recurring event, recurring_event_id identifies the recurring series as a whole. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| rooms | Meeting rooms associated to this event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | list(AssistantApiCoreTypesCalendarEventRoom) |
| start | The start time of the event. This event is an all-day event if start has no time_of_day. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | AssistantApiDateTime |
| summary | The title of the event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| visibility | Optional visibility of the event. | AssistantApiCoreTypesCalendarEvent | This proto contains the information of a calendar event, including title, start time, end time, etc. LINT.IfChange(CalendarEvent) NEXT_ID: 26 | String |
| displayName | Display name, present only if available. | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | String |
| Email address of the attendee (calendar), for regular events. For +Events, this field is not populated, instead “id” is used. | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | String | |
| givenName | Given (first) name, present only if available. This is used for generating meeting titles as given name is preferred over display (full) name (ie: “Jeff : Sundar” is better than “Jeff Dean : Sundar Pichai”). | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | String |
| id | Profile ID of the principal, for +Events. For regular events, this field is not populated, instead “email” is used. | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | String |
| organizer | Is this the organizer? | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | boolean |
| responseStatus | Attendees response status. | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | String |
| self | Is this the owner of this copy of the event? | AssistantApiCoreTypesCalendarEventAttendee | Next id: 8 | boolean |
| conferenceId | ID that corresponds to in ConferenceData.conference_id in calendar.common.ConferenceData proto. For Meet, this is the identifier used to join a meeting via URL. | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| dialInNumberClasses | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | list(String) | |
| phoneNumberUri | Default meeting phone number, for example: “tel:+1-475-777-1840” | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| pinNumber | A PIN that the participant will need to input after dialing in the conference. | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| provider | Provider info for the meeting. | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | AssistantApiCoreTypesProvider |
| regionCode | The region code for the default meeting phone number | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| source | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String | |
| universalPinNumber | The universal meeting PIN number for phone numbers in all available countries | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| url | URL that can be used to join the meeting. | AssistantApiCoreTypesCalendarEventMeetingContact | Next id: 10 | String |
| Room email that identifies the room and is used to book it. | AssistantApiCoreTypesCalendarEventRoom | A room that is available for a potential meeting or has been booked for a scheduled meeting. Next id: 4 | String | |
| locationDetails | Additional room details. Read-only, populated on request. | AssistantApiCoreTypesCalendarEventRoom | A room that is available for a potential meeting or has been booked for a scheduled meeting. Next id: 4 | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails |
| name | Room name (ex: “MTV-PR55-5-A-Shadow 5K0 (13) GVC (No external guests)”). | AssistantApiCoreTypesCalendarEventRoom | A room that is available for a potential meeting or has been booked for a scheduled meeting. Next id: 4 | String |
| building | Building where the room is (ex: “PR55”). | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | String |
| city | City where the room is (ex: “MTV”). | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | String |
| floor | Floor where the room is (ex: “5”). | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | String |
| latitude | The latitude in degrees. | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | float |
| longitude | The longitude in degrees. | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | float |
| section | Section in the floor (ex: “A”). | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | String |
| simpleName | Room name (ex: “Shadow 5K0”). | AssistantApiCoreTypesCalendarEventRoomRoomLocationDetails | Room location details. Read-only, populated on request. Next id: 8 | String |
| castAppId | The cast app id. |cast_app_id| is the ID of the cast app used on the current device and |content_app_id| is the ID of the app that provides the actual content. For example, in a group playback, on a follower device, the |cast_app_id| is the follower cast app ID and the |content_app_id| is the leader cast app ID. | AssistantApiCoreTypesCastAppInfo | The cast app information of the provider. | String |
| contentAppId | The id of the cast app that provides the content in a group. The field will always be filled. In the case of a group playback and the current device is a follower, the |cast_app_id| has the ID of the follower app, and |content_app_id| has ID of the actual content app. In all other cases, |content_app_id| and |cast_app_id| will be the same. | AssistantApiCoreTypesCastAppInfo | The cast app information of the provider. | String |
| localizedAppName | The localized app name. | AssistantApiCoreTypesChromeOsAppInfo | The ChromeOS app information of the provider. Next ID: 3 | String |
| packageName | Unique package name that identifies a ChromeOS app of the provider. | AssistantApiCoreTypesChromeOsAppInfo | The ChromeOS app information of the provider. Next ID: 3 | String |
| agentStyle | AssistantApiCoreTypesCloudProviderInfo | The third party provider information. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | |
| directoryUrl | URL to a directory page about the third party agent in Assistant HQ. This is a universal (https) URL that may be handled natively by clients to show HQ or launch to the HQ directory web page. | AssistantApiCoreTypesCloudProviderInfo | The third party provider information. | String |
| logoUrl | The logo url for the third party provider. | AssistantApiCoreTypesCloudProviderInfo | The third party provider information. | String |
| name | The user visible name of the cloud provider, which may be used for example in the chat header during a conversation with the third party. | AssistantApiCoreTypesCloudProviderInfo | The third party provider information. | String |
| backgroundColor | The background color of the agent. Used if no background image is specified for the given display orientation, or if the provided background image does not fit. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | AssistantApiCoreTypesColor |
| headerTheme | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | String | |
| landscapeBackgroundImageUrl | URL for the background image of the agent on landscape display. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | String |
| logoUrl | URL for the image containing the 3p logo. This can include logomark and logotype, or logotype only. If present, this can be used in place of the square logo contained in the top level logo_url field in CloudProviderInfo. See go/cards-logo-customization for details on applying this logo. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | String |
| maskColor | The color of the mask to apply to the background. See go/aog-cards-background-mask for details on applying this mask. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | AssistantApiCoreTypesColor |
| portraitBackgroundImageUrl | URL for the background image of the agent on portrait display. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | String |
| primaryColor | The primary color of the agent. Used by the client to style the header and suggestion chips. | AssistantApiCoreTypesCloudProviderInfoAgentStyle | The style customizations for the 3p agent. | AssistantApiCoreTypesColor |
| alpha | The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 – alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0). | AssistantApiCoreTypesColor | Represents a color in the RGBA color space. This message mirrors google.type.Color. | number |
| blue | The amount of blue in the color as a value in the interval [0, 1]. | AssistantApiCoreTypesColor | Represents a color in the RGBA color space. This message mirrors google.type.Color. | number |
| green | The amount of green in the color as a value in the interval [0, 1]. | AssistantApiCoreTypesColor | Represents a color in the RGBA color space. This message mirrors google.type.Color. | number |
| red | The amount of red in the color as a value in the interval [0, 1]. | AssistantApiCoreTypesColor | Represents a color in the RGBA color space. This message mirrors google.type.Color. | number |
| agentId | Pantheon Project ID that uniquely identifies the consumer project ID. Required | 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 | String |
| deviceId | Unique identifier for the device. Example: DBCDW098234. Required | 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 | String |
| agsaClientInstanceId | The client_instance_id on devices with GSA. See ‘client_instance_field’ in go/androidids. | 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 | String |
| alloDeviceId | Allo Id. Corresponds to the GBotRequest.Sender.sender. NOTE(dychen): This may change to standard android/ios physical device ids in order to enable shared data (e.g. installed app on physical device shared between Allo and Opa apps on Nexus). | 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 | String |
| canonicalDeviceId | A unique device ID for Assistant devices as proposed by go/ocelot-team to solve the device id fragmentation problem. The value of this id is the HomeGraph id of the device. See go/ocelot-track-0-registry-design. New surfaces should use the canonical_device_id instead of using other ids, and the registration should utilize the DeviceDataLayer (go/ddl-v0). Please contact the assistant-state-management@ team for guidance. Note: We didn’t reuse |home_graph_device_id| because in Assistant code base |home_graph_device_id| is common to associate it with 3P devices. See go/project-yellowstone for more context. | 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 | String |
| castDeviceId | If set, indicates that the device is a cast device, and contains the UUID of the cast device. Corresponds to the device_id field of the CastDevice proto. | 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 | String |
| clientInstanceId | DUSI (go/dusi) is used as the identifier here. This identifier is unique to the user and device. This will help identify which device or application the user’s request originated from. This is not to be confused with the client_instance_id that android devices provide. This is currently used by surfaces that use the assistant-legacy-nexus and assistant-legacy-clockwork pipelines. DUSI is created and set in S3. This field is only filled for GAIA requests. | 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 | String |
| connectedDockId | A device ID produced by a connected dock, which is registered in HomeGraph. | 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 | String |
| deviceConfig | The unique DeviceConfig to the specific third party device. It is also used by Android Auto Embedded first party device. See go/opa-ids. | 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 | AssistantApiCoreTypesDeviceConfig |
| deviceType | DEPRECATED. assistant.api.core_types.governed.SurfaceIdentity.surface_type field should be used instead. The device’s surface type. This is the string version of surface_type. The server should use the SurfaceType value derived from this string. If the device_type isn’t supported within the SurfaceType enum, it will be set as UNKNOWN. Developers should use the enum in ServerParams instead of this string. WARNING: Clients are not actually setting this field. This field will be removed once references to it within the code base have been removed. | 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 | String |
| homeGraphDeviceId | The unique device ID for HomeGraph devices. This is the HomeGraph ID, created when the device is registered into HomeGraph. It is immutable for the same device unless it is completely deleted and recreated. See go/home-graph for details. | 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 | String |
| libassistantDeviceId | The unique ID for libassistant based devices. See go/libassistant-id for details. | 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 | String |
| multiHotwordArbitrationDeviceId | If set, indicates that the device is participating the multi-hotword arbitration and the id is an UUID to distinguish it from other devices. It should also be consistent between requests from a single device within a session (or short duration). | 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 | String |
| opaIosDeviceId | The unique device ID for the Assistant App on iOS. See go/opa-ios-design for details. | 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 | String |
| quartzDeviceId | The unique ID of a Quartz device. See go/quartz-design-doc for more details. Quartz ID is a hash of (android_id + gaia). | 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 | String |
| deviceId | The identifier of the device. | 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. | AssistantApiCoreTypesDeviceId |
| gaiaId | The identifier of the user. | 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. | String |
| localizedAppName | The localized app name. | AssistantApiCoreTypesHomeAppInfo | The Home app information of the provider. Next ID: 3 | String |
| packageName | Unique package name that identifies a Home app of the provider. | AssistantApiCoreTypesHomeAppInfo | The Home app information of the provider. Next ID: 3 | String |
| accessibilityText | A text description of the image to be used for accessibility, e.g. screen readers. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| appIconIdentifier | App identifier. This field is specific to mobile surfaces and stands for app package name for Android surface, and app bundle identifier for iOS. In case identifier is specified but invalid, some default icon will be used, e.g. PackageManager.getDefaultActivityIcon() for Android. If you want to show image for AGSA versions which don’t support this field, you can specify source_url as backup. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| badgeImage | This is the image that is displayed as the badge on the main image. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | AssistantApiCoreTypesImage |
| content | Content of the image in bytes. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| height | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | integer | |
| imageSource | Indicate the data source where the image is fetched. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| jsonContent | Content of image in form of JSON representation. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| letterDrawableText | Text used to generate a letter drawable (a letter icon with color). It will be the default icon if the source_url is empty or cannot be rendered. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| providerUrl | Url of the image provider, which is the website containing the image. For example, https://www.agentx.com. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| sourceUrl | The source url of the image. For example, https://www.agentx.com/logo.png | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| sourceUrlType | Type of the source url. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | String |
| width | The width and height of the image in pixels. | AssistantApiCoreTypesImage | An image represents the data about an image or a photo. NextId: 13 | integer |
| type | Specifying which type of internal provider. | 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. | String |
| bundleIdentifier | Bundle identifier that identifies an iOS app of the provider. | AssistantApiCoreTypesIosAppInfo | The iOS app information of the provider. Next ID: 4 | String |
| localizedAppName | The localized app name. | AssistantApiCoreTypesIosAppInfo | The iOS app information of the provider. Next ID: 4 | String |
| openAppUrl | A URL to open the provider’s app. | AssistantApiCoreTypesIosAppInfo | The iOS app information of the provider. Next ID: 4 | String |
| localizedAppName | The localized app name. | AssistantApiCoreTypesKaiOsAppInfo | The KaiOS app information of the provider. Next ID: 4 | String |
| openAppUrl | A URL to open the provider’s app. | AssistantApiCoreTypesKaiOsAppInfo | The KaiOS app information of the provider. Next ID: 4 | String |
| packageName | Unique package name that identifies a KaiOS app of the provider. | AssistantApiCoreTypesKaiOsAppInfo | The KaiOS app information of the provider. Next ID: 4 | String |
| accuracyMeters | The accuracy of the coordinates in meters. | AssistantApiCoreTypesLocationCoordinates | Geographic coordinate information for location. | float |
| latDegrees | Latitude degrees. | AssistantApiCoreTypesLocationCoordinates | Geographic coordinate information for location. | float |
| lngDegrees | Longitude degrees. | AssistantApiCoreTypesLocationCoordinates | Geographic coordinate information for location. | float |
| appName | App name of the message notification, e.g. Hangouts. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| bundleId | The key used to group this notification into a cluster. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| dataUri | Uri for the attachment (image, audio, video etc.). | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| groupName | Name of the group associated with the message notification. This field is set iff this is a group message. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| groupingKey | The group key of a proactive notification. Details in assistant.api.client_op.NotificationArgs.grouping_key. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| index | Index of the message notification. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | integer |
| markAsReadActionAvailable | Boolean indicating if the mark_as_read action is available for this message. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | boolean |
| messageLength | Length of the message/notification content in characters. Note: We can’t send the full content because of privacy restriction, preventing sending client content to our backends. Concatenated message_length of all notification_entries. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | integer |
| messageRecipientType | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String | |
| messageWordCount | Word count of the message | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | integer |
| mimeType | Mime type of the data_uri. e.g. ‘audio/wav’, ‘video/mp4’, ‘image/png’. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| notificationEntries | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | list(AssistantApiCoreTypesMessageNotificationNotificationEntry) | |
| notificationIconKey | On-device cache key for notification icon. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| notificationKey | String key of the notification. It is the key from original StatusBarNotification received from Android OS. It is used to identify the original notification to send a reply. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| opaqueToken | The opaque_token of a proactive notification. Details in assistant.api.client_op.NotificationArgs.opaque_token. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| packageName | App pkg of the message notification, e.g. “com.google.android.talk”. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| postTime | Timestamp of the last notification’s post time. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| replyActionAvailable | Boolean indicating if the reply action is available for this message. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | boolean |
| sender | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | AssistantApiCoreTypesMessageNotificationPerson | |
| senderName | Sender’s name of the message notification, e.g. Elsa. Last sender name in case of a group conversation. | AssistantApiCoreTypesMessageNotification | This proto captures the contents of a messaging app notification that is typically part of a conversation thread. Next Id: 21 | String |
| audioDuration | Duration of audio message. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | String |
| charCount | Count of characters in the message body in the notification. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | integer |
| dataUri | Uri for the attachment (image, audio, video etc.). | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | String |
| messageBody | Note that this is not present in production traffic. Content of the message body in the notification. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | String |
| mimeType | Mime type of the data_uri. e.g. ‘audio/wav’, ‘video/mp4’, ‘image/png’. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | String |
| postTime | Timestamp of the notification’s post time. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | DateTime |
| sender | Sender of the message notification. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | AssistantApiCoreTypesMessageNotificationPerson |
| wordCount | Count of words in the message body in the notification. | AssistantApiCoreTypesMessageNotificationNotificationEntry | Structure of each notification in the MessageNotification Bundle. Attribute sender_name could be different in case of group messages. Next Id: 9 | integer |
| isImportant | AssistantApiCoreTypesMessageNotificationPerson | Mirrors part of https://developer.android.com/reference/android/app/Person Next Id: 4 | boolean | |
| key | AssistantApiCoreTypesMessageNotificationPerson | Mirrors part of https://developer.android.com/reference/android/app/Person Next Id: 4 | String | |
| name | AssistantApiCoreTypesMessageNotificationPerson | Mirrors part of https://developer.android.com/reference/android/app/Person Next Id: 4 | String | |
| androidAppInfo | The android app information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesAndroidAppInfo |
| castAppInfo | The cast app information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesCastAppInfo |
| chromeosAppInfo | The ChromeOS app information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesChromeOsAppInfo |
| cloudProviderInfo | The third party provider information. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesCloudProviderInfo |
| fallbackUrl | A URL to fallback to if app can not be opened. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | String |
| homeAppInfo | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesHomeAppInfo | |
| iconImageUrl | Public URL pointing to an icon image for the provider. e.g. https://lh3.googleusercontent.com/UrY7BAZ-XfXGpfkeWg0zCCeo-7ras4DCoRalC_WXXWTK9q5b0Iw7B0YQMsVxZaNB7DM | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | String |
| internalProviderInfo | The internal assistant provider information. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesInternalProviderInfo |
| iosAppInfo | The iOS app information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesIosAppInfo |
| kaiosAppInfo | The KaiOS app information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesKaiOsAppInfo |
| sipProviderInfo | The sip information of the provider. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesSipProviderInfo |
| webProviderInfo | The web provider information. | AssistantApiCoreTypesProvider | Provider. Like, Spotify or iHeartRadio. Next ID: 13 | AssistantApiCoreTypesWebProviderInfo |
| androidAppInfoDelta | The android app information of the provider. | 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 | AssistantApiCoreTypesAndroidAppInfoDelta |
| fallbackUrl | A URL to fallback to if app can not be opened. | 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 | String |
| iconImageUrl | Public URL pointing to an icon image for the provider. e.g. https://lh3.googleusercontent.com/UrY7BAZ-XfXGpfkeWg0zCCeo-7ras4DCoRalC_WXXWTK9q5b0Iw7B0YQMsVxZaNB7DM | 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 | String |
| category | The category related with the ringtone. It’s used to generate ringtone related with the category if the entity_mid is not be populated. E.g. for instrument, the ringtone may be piano sound. | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | String |
| characterAlarmMetadata | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataCharacterAlarmMetadata | |
| characterTag | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | String | |
| entityMid | The freebase mid of the entity related to the ringtone. It will be used to generate the ringtone for the alarm or timer (with support for i18n). For instance, for the “cat” mid, the related ringtone will be a cat sound in some language, and for the “Beyonce” mid, the ringtone will be, e.g., a playlist of Beyonce’s best hits. | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | String |
| funtimeMetadata | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | |
| genMlAlarmMetadata | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataGenMlAlarmMetadata | |
| gentleWakeInfo | Gentle wake information for this alarm. | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataGentleWakeInfo |
| onDeviceAlarmMetadata | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataOnDeviceAlarmMetadata | |
| onDeviceAlarmSound | Will be deprecated. Use OnDeviceAlarmMetadata. | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | String |
| routineAlarmMetadata | AssistantApiCoreTypesRingtoneTaskMetadata | Task metadata information describing the ringtone. Next id: 11 | AssistantApiCoreTypesRingtoneTaskMetadataRoutineAlarmMetadata | |
| agentIds | 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. | AssistantApiCoreTypesRingtoneTaskMetadataCharacterAlarmMetadata | list(String) | |
| characterTags | 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. | AssistantApiCoreTypesRingtoneTaskMetadataCharacterAlarmMetadata | list(String) | |
| iconUrls | 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. | AssistantApiCoreTypesRingtoneTaskMetadataCharacterAlarmMetadata | list(String) | |
| agentIds | For FunTime alarms and timers, the media resources are provided through AOG apps during their ringtone. Multiple AoG agents can satisfy a label. So a random agent will be chosen from those that are supplied. See go/funtime-engdesign. | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | Used to make timers and alarms more delightful. See go/funtime-engdesign for more details. | list(String) |
| animationBlob | These bytes may represent the blob of the Rive animation that we pass to the Opal App. We will deprecate this field if we figure out a solution to load the animation from the web. | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | Used to make timers and alarms more delightful. See go/funtime-engdesign for more details. | String |
| animationUrl | Url for Rive animation that is brought up on ring. Rive is a lightweight animation library that is compatible with Flutter on Opal. See https://rive.app/. | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | Used to make timers and alarms more delightful. See go/funtime-engdesign for more details. | String |
| timerHeroUrl | The url used to load the image that is at the center of the timer during timer countdown visuals. | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | Used to make timers and alarms more delightful. See go/funtime-engdesign for more details. | String |
| ttsServiceRequestBytes | This is used to call S3 to realize the TTS. Is in the form of bytes because of a circular dependency issue in libassistant protos. It is a serialized proto of type speech.s3.TtsServiceRequest. | AssistantApiCoreTypesRingtoneTaskMetadataFuntimeMetadata | Used to make timers and alarms more delightful. See go/funtime-engdesign for more details. | String |
| isEnabled | 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). | boolean | |
| ringtoneLabel | Label for the generated ringtone. | 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). | String |
| effectDurationMs | Specifies how long the effect lasts. Allowed for effect to last after the alarm has started ringing. If unset or negative or 0, effect is assumed to last until alarm trigger time. | AssistantApiCoreTypesRingtoneTaskMetadataGentleWakeInfo | Gentle wake actions like slowly brightening the room/device screen leading up to the alarm firing (go/cube-gentle-wake-up). | String |
| isEnabled | Indicates if gentle wake action is to be performed before this alarm fires. This is enabled only if the device supports sunrise alarm capability. http://cs/symbol:assistant.api.SunriseFeaturesSupport | AssistantApiCoreTypesRingtoneTaskMetadataGentleWakeInfo | Gentle wake actions like slowly brightening the room/device screen leading up to the alarm firing (go/cube-gentle-wake-up). | boolean |
| startTimedeltaMs | Specifies how long before the alarm fire time, the wakeup effect will start. ALWAYS POSITIVE. | AssistantApiCoreTypesRingtoneTaskMetadataGentleWakeInfo | Gentle wake actions like slowly brightening the room/device screen leading up to the alarm firing (go/cube-gentle-wake-up). | String |
| onDeviceAlarmSound | Opal/UI layer will set this bit based on the user selection. | 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. | String |
| onDeviceAlarmSoundLabel | A string label to identify the alarm sound name. Opal/UI layer will set this as per product definition. This will be used to display the name of the selected ringtone. | 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. | String |
| ttsServiceRequestBytes | This is used to call S3 to realize the TTS. Is in the form of bytes because of a circular dependency issue in libassistant protos. It is a serialized proto of type speech.s3.TtsServiceRequest. This request will contain an ssml with the url to the ringtone files hosted on gstatic. | 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. | String |
| routineId | The unique id for each routine. When the alrm is dismissed, it will trigger the routine of the routine alarm’s creator if feasible. | AssistantApiCoreTypesRingtoneTaskMetadataRoutineAlarmMetadata | String | |
| providerId | The providers id (MID) which is the primary identifier for a call provider within the Assistant. A MID, or machine identifier, is a unique identifier issued by Knowledge Graph for all entities contained in it’s graph. | 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 | String |
| realm | Calling realm to be use for each call. i.e. For anonymous, this would be set to anonymous.chirp.google.com | 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 | String |
| useBirdsongTacl | If true, client should use the Birdsong TaCL API for this call. Uses the VoiceCallManager API by default. For more details: go/birdsong-migration-google-home | 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 | boolean |
| deviceId | The identifier of the device. | 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 | AssistantApiCoreTypesDeviceId |
| legacySurfaceType | DEPRECATED: The legacy device’s surface type enum. NOTE: Prefer using the ontological `surface_type` field above. If you need to access the legacy surface type, please file a bug and add it in your code to migrate to ontological surface type. | 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 | String |
| surfaceType | The device’s surface type. The types are defined at google3/assistant/api/core_types/surfaces.gcl. For more details, refer to go/ontologicalize-surface-type. | 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 | String |
| surfaceTypeString | DEPRECATED. The legacy device’s surface type string. NOTE: Prefer using the ontological `surface_type` field. The device’s surface type. This is the string version of the assistant.api.core_types.SurfaceType enum. The server should not use this field, rather it should use the SurfaceType value derived from this string. | 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 | String |
| surfaceVersion | The version of the surface/client. This is different from the Conversation protocol version. | 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 | AssistantApiCoreTypesSurfaceVersion |
| type | 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. | String | |
| major | 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. | integer | |
| minor | 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. | integer | |
| homeStorage | Serialized storage (context) persisted and retrieved for the app and home. | AssistantApiCoreTypesWebProviderInfo | The web information of the provider. Next ID: 5 | String |
| localizedAppName | The localized app name. | AssistantApiCoreTypesWebProviderInfo | The web information of the provider. Next ID: 5 | String |
| openAppUrl | A URL to open the provider’s app. | AssistantApiCoreTypesWebProviderInfo | The web information of the provider. Next ID: 5 | String |
| thirdPartyCustomNluInfo | Info about 3P Custom NLU used in this web provider. TODO(b/321644453) remove when QRewrite is able to call SERoot. | AssistantApiCoreTypesWebProviderInfo | The web information of the provider. Next ID: 5 | AssistantApiCoreTypesWebProviderInfoThirdPartyCustomNluInfo |
| locale | 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. | AssistantApiCoreTypesWebProviderInfoThirdPartyCustomNluInfo | String | |
| nluAgentId | Unique internal identifier of 3P Custom NLU agent. UUID. | AssistantApiCoreTypesWebProviderInfoThirdPartyCustomNluInfo | String | |
| nluAgentVersion | Identifies the 3P Custom NLU agent version. | AssistantApiCoreTypesWebProviderInfoThirdPartyCustomNluInfo | String | |
| localConnectivityEnabled | Whether the device has torus/usonia capabililities enabled or not. | AssistantApiCrossDeviceExecutionCapability | boolean | |
| remoteCastMediaEnabled | 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. | AssistantApiCrossDeviceExecutionCapability | boolean | |
| fallbackToTetheredDevice | 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. | AssistantApiDataValidateCapabilities | boolean | |
| day | The day, in 1…31. | AssistantApiDate | A Gregorian calendar date. | integer |
| month | The month, in 1…12. | AssistantApiDate | A Gregorian calendar date. | integer |
| year | The year, e.g. 2016. | AssistantApiDate | A Gregorian calendar date. | integer |
| date | A Gregorian calendar date. | AssistantApiDateTime | A date-time specification, combining a date and civil time (relative to a given timezone). | AssistantApiDate |
| timeOfDay | A civil time relative to a timezone. | AssistantApiDateTime | A date-time specification, combining a date and civil time (relative to a given timezone). | AssistantApiTimeOfDay |
| timeZone | A time zone in IANA format. | AssistantApiDateTime | A date-time specification, combining a date and civil time (relative to a given timezone). | AssistantApiTimeZone |
| endDate | End date of the range. | AssistantApiDateTimeRange | A representation of a range of time with start and end datetime specified. | AssistantApiDateTime |
| startDate | Start date of the range. | AssistantApiDateTimeRange | A representation of a range of time with start and end datetime specified. | AssistantApiDateTime |
| movement | These capabilities are scoped to abilities of the device to move around. | 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 | AssistantApiMovementCapabilities |
| surfaceIdentity | The set of information that helps the server identify the surface. | 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 | AssistantApiCoreTypesSurfaceIdentity |
| screen | These capabilities are scoped to the ability to see and interact with the Assistant through a screen. If the device has no screen it should send an empty ScreenCapabilities. Sending no ScreenCapabilities will cause this to be overridden with the surface default. | 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 | AssistantApiScreenCapabilities |
| callCapabilities | The call capabilities of this device. go/call-capabilities | 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 | AssistantApiCallCapabilities |
| systemNotificationRestrictions | Restrictions related to system-level notifications. This field is superficially similar to ProactiveNotificationOutput, but unlike that field which tracks a per-user preference on the OPA side, this field captures system level notifications restrictions. This field is not stored and is merged to capabilities from conversation params. It exists mostly for logging purposes of android channel state and global app-level notification opt out. | 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 | AssistantApiSystemNotificationRestrictions |
| sodaCapabilities | Capabilities related to SODA (Speech On-Device API). | 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 | AssistantApiSodaCapabilities |
| hasVoiceTelephony | Indicates that the device has connection to cellular network that allows it to make voice calls. This is distinct from device just being capable of voice telephony, because the device can be capable yet miss the suitable SIM card (for example, it could miss SIM card altogether, or have data-only SIM card). | 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 | boolean |
| lensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/lens-perception-sdk. | 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 | AssistantApiLensPerceptionCapabilities |
| cast | These capabilities are scoped to the cast abilities of this device. | 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 | AssistantApiCastCapabilities |
| deviceId | This is the same device id that is specified in the conversation protocol and should be unique to each device/user/model combination. For example, if a request is coming from a watch through AGSA the watch and AGSA should have different device_ids. Note: this field should only be used to determine which device the capabilities belong to and not to access the id of the device. Instead DeviceProperties should be used and accessed through ParamsAccessor. | 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 | AssistantApiCoreTypesDeviceId |
| thirdPartyCapabilities | Capabilities related to third party integration. | 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 | AssistantApiThirdPartyCapabilities |
| androidIntentCapabilities | Capabilites related to Android intent support. | 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 | AssistantApiAndroidIntentCapabilities |
| camera | These capabilities are scoped to the camera abilities of this device. | 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 | AssistantApiCameraCapabilities |
| deviceUxMode | Capabilities related to Android tablet UX experience. | 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 | String |
| assistantCapability | Capabilities if surface supports Google Assistant. | 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 | String |
| bluetoothCapabilities | Bluetooth capabilities related to usage of a feature. | 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 | AssistantApiBluetoothCapabilities |
| location | These capabilities are scoped to the location abilities of this device. | 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 | AssistantApiLocationCapabilities |
| notificationOutputRestrictions | Settings, that reflect whether a specific notification type is allowed for current device, e.g. if the user opted out from notification category or category group. This settings are server-side stored and evaluated unlike SystemNotificationRestrictions field. | 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 | AssistantApiNotificationOutputRestrictions |
| loggingOnlyData | Data which is produced for logging and debugging. Servers MUST NOT use this for any other purposes, such as branching on it. | 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 | AssistantApiLoggingOnlyData |
| notificationCapabilities | DEPRECATED: Use SystemNotificationRestrictions instead. Specifies whether the surface is able to display notifications. This field is superficially similar to ProactiveNotificationOutput, but unlike that field which tracks a per-user preference on the OPA side, this field captures whether the surface is capable of displaying notifications. | 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 | String |
| messageCapabilities | 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 | AssistantApiMessageCapabilities | |
| audioInput | These capabilities are scoped to the ability to gather audio. It includes information like the type of audio that can be gathered (e.g. public, private). | 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 | AssistantApiAudioInput |
| contactLookupCapabilities | 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 | AssistantApiContactLookupCapabilities | |
| outputRestrictions | These are user configured restrictions indicating what the device is allowed to output from the privacy point of view. | 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 | AssistantApiOutputRestrictions |
| software | These capabilities are scoped to the software available on the device as well as the set of supported Assistant features. | 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 | AssistantApiSoftwareCapabilities |
| communicationUiCapabilities | 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 | AssistantApiCommunicationUiCapabilities | |
| carUxRestrictions | UX restrictions for Auto. | 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 | list(String) |
| audioOutput | These capabilities are scoped to the ability to play audio. It includes information like the type of audio that can be played (e.g. public, private). | 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 | AssistantApiAudioOutput |
| popOnLockscreenCapability | Capability to support Pop on lockscreen. | 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 | String |
| dataValidateCapabilities | 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 | AssistantApiDataValidateCapabilities | |
| surfaceTypeString | DEPRECATED. surface_identity field below already contains this information. The device’s surface type. This is the string version of the assistant.api.core_types.SurfaceType enum. The server should not use this field, rather it should use the SurfaceType value derived from this string. | 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 | String |
| jwnCapabilities | Indicates if the client supports Javascript Whatsnext (go/jwn). Also contains the Jwn libraries present on the client along with their versions. | 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 | AssistantApiJwnCapabilities |
| safetyRestrictions | Indicates if the client has safety related restriction. | 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 | String |
| supportedLocale | Locales supported by assistant settings for speaking and display. This is independent from device language that is defined in device setting. New locales are added based on rollout, whitelist and app version releases because older versions does not have model support. Currently supported locale list differs by surface type. | 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 | list(String) |
| speechCapabilities | DEPRECATED Capabilities related to speech detection on devices. | 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 | AssistantApiSpeechCapabilities |
| nanos | Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive. | 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. | integer |
| seconds | Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. | 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. | String |
| clarificationDataSupported | Whether client supports clarification suggestion chip to be displayed see |assistant.suggestions.ClarificationData| | AssistantApiFeatureSpecificActionSupport | boolean | |
| supportedActivities | A list of fitness activity types supported by this client. | AssistantApiFitnessFeatureSupport | list(String) | |
| stateSyncMethod | Specifies the params proto that Fluid Actions uses to sync state with server. | AssistantApiFluidActionsSupport | String | |
| deviceId | DeviceId of the accessory device (eg. watch) Commonly the go/dusi (eg. client_instance_id) is provided. | AssistantApiGacsCapabilities | Capabilities of Google assistant conversation service(GACS) devices. These capabilites including supported GACS actions and response size limitations. | AssistantApiCoreTypesDeviceId |
| responseConfig | Configuration sent by device. | AssistantApiGacsCapabilities | Capabilities of Google assistant conversation service(GACS) devices. These capabilites including supported GACS actions and response size limitations. | GoogleAssistantAccessoryV1ResponseConfig |
| ttsEncoding | DEPRECATED: Format of TTS audio requested by the device. | AssistantApiGacsCapabilities | Capabilities of Google assistant conversation service(GACS) devices. These capabilites including supported GACS actions and response size limitations. | String |
| gcmRegistrationId | GCM registration id for the device. Used to pass messages to the device. | AssistantApiGcmCapabilities | Capabilities related to GCM. | String |
| supportsAssistantGcm | Assistant supports GCM on the device. ClientOps can be sent to it over GCM and will be executed. | AssistantApiGcmCapabilities | Capabilities related to GCM. | boolean |
| supportsClientInputOverGcm | If it is set to true, then it indicates to server that device is capable of receiving a GCM payload with serialized client input. The client input will be sent back to Assistant Server over conversation protocol. | AssistantApiGcmCapabilities | Capabilities related to GCM. | boolean |
| gestureSensing | Whether Gesture is supported. When false, override the value for tap and omniswipe. | AssistantApiGestureCapabilities | The gesture capabilities related to Selina. Next ID: 4 | boolean |
| omniswipeGestureCapable | Whether omniswipe is supported | AssistantApiGestureCapabilities | The gesture capabilities related to Selina. Next ID: 4 | boolean |
| tapGestureCapable | Whether tap is supported | AssistantApiGestureCapabilities | The gesture capabilities related to Selina. Next ID: 4 | boolean |
| guestAccessOnYoutube | AssistantApiGuestAccessOutput | Access settings for guests. | String | |
| confirmationMessageSupported | Whether the client supports confirmation messages in Immersive Canvas actions. | AssistantApiImmersiveCanvasSupport | boolean | |
| pauseSignalSupported | Whether the client support canvas pause signal. If true, the Assistant Server will send a signal when canvas transitioning to pause mode. | AssistantApiImmersiveCanvasSupport | boolean | |
| librariesVersionMap | The name and version of the jwn libraries currently stored on the client. These are the same that the server communicated when the library was first sent down. | AssistantApiJwnCapabilities | These capabilities are used to determine the jwn libraries and their versions that are present on the client. | map |
| supportedCompressionMode | Compression algorithms supported on the client. Server can choose one of these to compress WhatsNext Javascript programs and libraries. | AssistantApiJwnCapabilities | These capabilities are used to determine the jwn libraries and their versions that are present on the client. | list(String) |
| supportsJwn | Whether the client supports running jwn code. | AssistantApiJwnCapabilities | These capabilities are used to determine the jwn libraries and their versions that are present on the client. | boolean |
| hasLensPerception | Whether the device supports Lens Perception. | AssistantApiLensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/loa-lens-device-capabilities. Next ID: 6 | boolean |
| isLensDirectIntentAvailable | Indicates whether Lens supports Lens Direct Intent (go/lensdirectintent). | AssistantApiLensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/loa-lens-device-capabilities. Next ID: 6 | boolean |
| isLensLiveViewfinderAvailable | Indicates whether Lens supports Live view-finder experience. | AssistantApiLensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/loa-lens-device-capabilities. Next ID: 6 | boolean |
| isLensPostCaptureAvailable | Indicates whether Lens supports Post-capture experience with an image payload. | AssistantApiLensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/loa-lens-device-capabilities. Next ID: 6 | boolean |
| lensCapabilities | Contains the capabilities that Lens can support. | AssistantApiLensPerceptionCapabilities | Capabilities related to Lens Perception, i.e. image understanding. See go/loa-lens-device-capabilities. Next ID: 6 | AssistantApiLensPerceptionCapabilitiesLensCapabilities |
| dining | The presence of this message means that Dining is supported. | 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 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesDining |
| education | The presence of this message means that Education is supported. | 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 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesEducation |
| outdoor | The presence of this message means that Outdoor is supported. | 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 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesOutdoor |
| shopping | The presence of this message means that Shopping is supported. | 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 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesShopping |
| text | The presence of this message means that intenting directly into the text filter is supported. | 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 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesText |
| translate | The presence of this message means that Translation is supported. | 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 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesTranslate |
| isTextToSpeechSupported | Indicates whether text-to-speech is supported. | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesText | Text recognition capability. | boolean |
| supportedLanguageTags | The list of language IETF BCP 47 tags that are supported. See the full details in the comment on the equivalent field in: http://google3/java/com/google/android/apps/gsa/search/shared/service/proto/lens_service_event.proto;l=55;rcl=355512559 | AssistantApiLensPerceptionCapabilitiesLensCapabilitiesTranslate | Translation capability. | list(String) |
| channelsByProvider | A list of channel providers each of which provides a list of its channels. | AssistantApiLiveTvChannelCapabilities | list(AssistantApiLiveTvChannelCapabilitiesChannelsByProvider) | |
| channels | 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. | AssistantApiLiveTvChannelCapabilitiesChannelsByProvider | list(AssistantApiLiveTvChannelCapabilitiesLiveTvChannel) | |
| inputId | An identifier to identify the input source. For example for TIF based channels, this will be the TIF input ID to differentiate different tuner apps. See https://source.android.com/devices/tv | AssistantApiLiveTvChannelCapabilitiesChannelsByProvider | String | |
| providerType | Type of provider who provides this channel input. | AssistantApiLiveTvChannelCapabilitiesChannelsByProvider | String | |
| channelId | Unique channel identifier. | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | String | |
| channelName | A list of channel names and synonyms. | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | list(String) | |
| channelNumber | Channel number displayed to user. Optional. | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | String | |
| deeplink | A deep link into the Live player app that tunes to this channel. | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | String | |
| mid | KG mid of the channel if it exists in KG. | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | String | |
| networkMid | Network KG mid of the channel if it exists in KG | AssistantApiLiveTvChannelCapabilitiesLiveTvChannel | String | |
| providerInfo | Contains detailed provider information such as android app package name. | AssistantApiLiveTvProvider | AssistantApiCoreTypesProvider | |
| providerKey | A provider enum string for OTT providers. The available key can be found in go/ump-provider-enum For Tuner provider, the provider key would be an ID the tuner app uploaded from TIF. See https://source.android.com/devices/tv | AssistantApiLiveTvProvider | String | |
| providerType | AssistantApiLiveTvProvider | String | ||
| gpsAvailable | AssistantApiLocationCapabilities | boolean | ||
| acpVersion | A user-readable string describing the ACP version (go/acp-version) of the client app used by the user to originate the conversation. | 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 | String |
| androidId | Random identifier assigned to Android mobile devices. Older logs may have previously stored other kinds of android IDs in this field, but all current logs should use the GServices Id. See go/androidids. | 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 | String |
| appVersion | A user-readable string describing the version of the client app used by the user to originate the conversation. | 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 | String |
| assistantSettingsSource | An enum specifying when was this ATV AssistantSettings entry initially created. | 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 | String |
| boardName | The type of board used by manufacturer for this device | 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 | String |
| boardRevision | The revision of board used | 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 | String |
| castAssistantSettingLinkingResult | This field records the linking status between Assistant setting entry and Cast setting entry. Currently only ATV surface populates this field for profiling purpose. | 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 | AssistantApiCastAssistantSettingLinkingResult |
| deviceModel | A user-readable string describing the device’s hardware platform. | 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 | String |
| embedderBuildInfo | Any relevant info concerning the build options of the embedder (that is the software which runs as the ‘driver’ of an Assistant library, such as libassistant. the embedder is typically built by a third party) | 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 | String |
| initialAppVersion | A string recording the app version that is initially used to created this settings entry. | 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 | String |
| isPrimaryUser | Boolean field to indicate whether a certain user is the primary user of a device or not. This is useful for distinguishing the user0 from other users given user0 might have certain privileges (Eg: Hubmode on Tangor) | 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 | boolean |
| mdnsDisplayName | default display name of device over mdns. This is specified at the factory, not specified by the user. | 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 | String |
| platformBuild | A user-readable string describing the device’s software platform. | 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 | String |
| virtualReleaseChannel | A string describing device’s release channel. For cast devices, the string will look like “qa-beta-channel”, “eng-no-update”, etc. | 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 | String |
| skipConfirmationsWhilePlaying | Whether to prevent confirmations (text, tts) for media control actions while media is playing so that the media session is not interrupted. | AssistantApiMediaControlSupport | boolean | |
| fallbackToTetheredDeviceAppCapabilities | 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). | AssistantApiMessageCapabilities | boolean | |
| preferTargetingPrimaryDevice | 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. | AssistantApiMessageCapabilities | boolean | |
| supportedRecipientTypes | Should only be checked if nonempty. | AssistantApiMessageCapabilities | list(String) | |
| deviceSettingStatus | The current setting status of message summary on current device. | AssistantApiMessageSummarySupport | LINT.IfChange(messageSummarySupport) | String |
| lastVoiceOptInFlowTimestamp | Last time that voice opt-in flow has been triggered. | AssistantApiMessageSummarySupport | LINT.IfChange(messageSummarySupport) | DateTime |
| readNotificationSummarizationSupported | Whether the client supports message summarization. | AssistantApiMessageSummarySupport | LINT.IfChange(messageSummarySupport) | boolean |
| voiceOptInFlowCounter | The voice consent flow counter on current device. | AssistantApiMessageSummarySupport | LINT.IfChange(messageSummarySupport) | integer |
| mobility | Indicates how much the device moves around. E.g., TV has a low mobility level, while Auto has a very high level. | AssistantApiMovementCapabilities | String | |
| optOutState | AssistantApiNotificationOutputRestrictions | AssistantApiNotificationOutputRestrictionsOptOutState | ||
| categoryGroupState | AssistantApiNotificationOutputRestrictionsOptOutState | Per category/category group notification opt out settings. | list(AssistantApiNotificationOutputRestrictionsOptOutStateCategoryGroupState) | |
| categoryState | AssistantApiNotificationOutputRestrictionsOptOutState | Per category/category group notification opt out settings. | list(AssistantApiNotificationOutputRestrictionsOptOutStateCategoryState) | |
| categoryGroup | AssistantApiNotificationOutputRestrictionsOptOutStateCategoryGroupState | String | ||
| state | AssistantApiNotificationOutputRestrictionsOptOutStateCategoryGroupState | String | ||
| category | AssistantApiNotificationOutputRestrictionsOptOutStateCategoryState | String | ||
| state | AssistantApiNotificationOutputRestrictionsOptOutStateCategoryState | String | ||
| cloudCapability | The OEM Cloud execution capability of this device, containing routing details for cloud fulfillment. | 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. | AssistantDevicesPlatformProtoCloudCapability |
| cloudDeviceCapabilities | If fulfillment is done via 3P cloud and 3P supports device capabilities, this field will be set. | 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. | map |
| deviceModelId | Device Model Id from DeviceModelPackage. | 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. | String |
| deviceModelRevisionId | Device Model Revision Id from DeviceModelPackage. | 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. | String |
| deviceSpecificData | Opaque supported action data related to a specific domain of devices, for example for car. go/car-talk-registration-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. | String |
| internalCapability | Internal-only config containing metadata about the Device Model, for example to control the ranking behavior. | 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. | AssistantDevicesPlatformProtoInternalCapability |
| thirdPartyActionConfig | 3P Action Metadata, populated from the Device Model lookup and the client request parameters. For example, an Assistant SDK request would have the billed project id of the Assistant request added here in order to enable any Device Actions developed using the same Google Cloud project. This data is sent to Service Engine to mask triggering for Device Actions. | 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. | AssistantApiThirdPartyActionConfig |
| isLocalNetworkArbitrationSupported | Capabilities related to local network arbitration (go/local-network-arbitration). Indicates if the device is capable of being a host device in the LAN whiling doing local network arbitration. | AssistantApiOnDeviceAssistantCapabilities | Definitions of on-device assistant capabilities. | boolean |
| isOnDeviceArbitrationSupported | Capabilities related to on-device arbitration(go/arbitration-on-device). | AssistantApiOnDeviceAssistantCapabilities | Definitions of on-device assistant capabilities. | boolean |
| isOnDeviceAssistantSupported | Indicates if on-device assistant is enabled on this device. Example usecases: NGA (go/nga) or Marble (go/marble). | AssistantApiOnDeviceAssistantCapabilities | Definitions of on-device assistant capabilities. | boolean |
| isOnDeviceUnderstandingSupported | This may be used by NGA. E.g. if understanding happens on device, we can have more aggressive logic when fulfilling some features on the server side, like teleport. | AssistantApiOnDeviceAssistantCapabilities | Definitions of on-device assistant capabilities. | boolean |
| isOnDeviceSmartHomeSupported | Master bit for on-device Smart Home features. | AssistantApiOnDeviceSmartHomeCapabilities | Definitions of on-device Smart Home capabilities. Next ID: 2 | boolean |
| isSupported | Determines if an on-device storage is supported. | AssistantApiOnDeviceStorageCapabilities | The on-device storage capabilities found on the device. | boolean |
| googlePhotoContent | The type of Google Photo content which the device can output. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| guestAccessOutput | Access settings for guests. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | AssistantApiGuestAccessOutput |
| personalData | The level of personal data which the device can output. See go/personal-readout for detail. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| proactiveNotificationOutput | This controls if the server can proactively send notification to users, and it does not affect scenarios that users ask for information. The notification may include TTS and lights. It could be only lights for chirp. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| proactiveOutput | Restrictions on displaying and interacting with content on proactive surfaces (e.g. Dragonglass home screen). Note: NEVER access this field of OutputRestrictions directly, use the code in assistant/assistant_server/settings/device/device_settings_util.h instead. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | AssistantApiProactiveOutput |
| youtubeAutoplayRestriction | Whether YouTube autoplay is allowed for queries from the user to this device. See go/assistant-youtube-settings for details. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| youtubeContent | The type of YouTube content which the device can output. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| youtubeTvContent | The type of YouTube TV content which the device can output. | AssistantApiOutputRestrictions | These are user configurable permissions representing what the device is allowed to output. Next ID: 11 | String |
| allowAllPersonalData | Allows displaying all personal data on proactive surfaces with no face match capability. | AssistantApiProactiveOutput | Next ID: 7 | boolean |
| androidTvAssistantSettingsSource | For ANDROID_TV devices, the location that this setting was last changed from. Note: this structure allows to extend to more per-vertical bits in the future. | AssistantApiProactiveOutput | Next ID: 7 | String |
| healthAndFitnessProactive | Allows displaying Health and Fitness content on proactive surfaces. This is a sub bit of the device-wide PR bit – the device-wide PR bit must be enabled AND this vertical sub bit must be enabled for H&F content to be shown. This bit will be available on all surfaces that have the proactive-bit enabled. If the proactive-bit is not enabled, then we do not show health and fitness content at all (or even allow access to this setting). | AssistantApiProactiveOutput | Next ID: 7 | String |
| photosProactive | Allows displaying photos content on Dragonglass proactive surfaces. This is a sub bit of the device-wide PR bit – the device-wide PR bit must be enabled AND this vertical sub bit must be enabled for photos content to be shown on Dragonglass surfaces. This bit will be available on all Dragonglass surfaces that have the proactive-bit enabled. If the proactive-bit is not enabled or it’s not a Dragonglass surface, then we do not show proactive photos content at all, nor allow access to this setting. See go/opa-photos-sg-settings for more details. | AssistantApiProactiveOutput | Next ID: 7 | String |
| userMatchProactive | Settings for displaying personal data on proactive surfaces with face match capability. | AssistantApiProactiveOutput | Next ID: 7 | String |
| protobufData | The serialized protocol buffer. | 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. | String |
| protobufType | The type of the protocol buffer to use. This must be a resolvable name (Namespace.ProtoName) and refer to a proto which is either compiled in to both client and server (e.g. a base proto type) or to one which is part of the conversation package. | 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. | String |
| begin | The first day of the recurrence. If begin is not set, then the reminder will start infinitely in the past. | 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. | AssistantApiDate |
| blacklistedRanges | A list of blacklisted dates to skip the alarm on. | 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. | list(AssistantApiDateTimeRange) |
| dayOfMonth | Specifies the date in a month. For example, if day_of_month is 15, then it represent the 15th day of the specified month. | 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. | list(integer) |
| dayOfWeek | Specifies a weekly or daily recurrence. Constraint: The date falls on one of these days of the week, in 0…6 (Sunday…Saturday). | 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. | list(integer) |
| end | The last day of the recurrence. | 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. | AssistantApiDate |
| every | Multiplier on the frequency of the recurrence. Use this to specify patterns that recur every X days, months, years, etc. Example: [remind me to call mom every 2nd week]. Default is 1 (every day, every month, every year). | 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. | integer |
| monthOfYear | Specifies the month in a year. Constrain: the month falls on one of these months, in 1, 2, … 12 (January…December). | 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. | list(integer) |
| numOccurrences | The number of occurrences after which the recurrence should end. | 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. | integer |
| weekOfMonth | Specifies the index of week in a month. For example, the second Tuesday every month, in this case, week_of_month should be 2. | 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. | list(integer) |
| enabledExtensions | List of enabled Robin extensions. | 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. | list(String) |
| robinStatus | 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. | AssistantApiRobinCapabilitiesRobinStatus | |
| supportedRobinOps | List of supported RobinOps. | 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. | list(String) |
| available | AssistantApiRobinCapabilitiesRobinStatus | Current Robin status of the client. | AssistantApiRobinCapabilitiesRobinStatusRobinStatusAvailable | |
| notAvailable | AssistantApiRobinCapabilitiesRobinStatus | Current Robin status of the client. | AssistantApiRobinCapabilitiesRobinStatusRobinStatusNotAvailable | |
| optedIn | AssistantApiRobinCapabilitiesRobinStatus | Current Robin status of the client. | AssistantApiRobinCapabilitiesRobinStatusRobinStatusOptedIn | |
| optedOut | AssistantApiRobinCapabilitiesRobinStatus | Current Robin status of the client. | AssistantApiRobinCapabilitiesRobinStatusRobinStatusOptedOut | |
| reasons | AssistantApiRobinCapabilitiesRobinStatusRobinStatusNotAvailable | Robin is not available and can not be enabled by the user. | list(integer) | |
| fontScaleFactor | The scale factor used to convert Scalable Pixel (SP) units to Density-independent Pixel (DP) units (DP = SP * scale factor). Fonts are measured in units of SP, and on some platforms such as Android the SP to DP scale factor can be affected by the font size a user selects in accessibility settings. | 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 | number |
| inputType | The types of input that this screen supports. Note that this can be empty in which case the screen’s input type is unknown. | 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 | list(String) |
| mask | Mask defined for this device, if any. | 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 | AssistantApiScreenCapabilitiesMask |
| protoLayoutTargetedSchema | The targeted schema version for ProtoLayout requests. | 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 | AssistantApiScreenCapabilitiesProtoLayoutVersion |
| resolution | If this field is absent, the resolution of the screen is unknown. | 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 | AssistantApiScreenCapabilitiesResolution |
| screenOff | If screen is turned off. | 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 | boolean |
| screenStateDetection | The ability of the client to correctly report screen state. | 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 | String |
| supportedRenderingFormat | The primary supported rendering format for display on the device’s screen. This may be used to determine what format of card to be returned when rendering cards. | 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 | String |
| supportedScreenStates | The screen states that the client supports. The current screen state is specified in DeviceProperties.screen. | 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 | list(String) |
| visionHelpEnabled | Whether the device enabled vision help features in accessibility settings. The settings is config in Assistant App and on-device settings, and stored in footprints. When enabled, font, color and TTS will be adjusted. | 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 | boolean |
| type | AssistantApiScreenCapabilitiesMask | A mask applied to the screen’s pixel space to determine regions not visible on the physical device. | String | |
| major | AssistantApiScreenCapabilitiesProtoLayoutVersion | Version info for ProtoLayout requests. | integer | |
| minor | AssistantApiScreenCapabilitiesProtoLayoutVersion | Version info for ProtoLayout requests. | integer | |
| dpi | Dots (pixels) per inch of the screen. | AssistantApiScreenCapabilitiesResolution | A Resolution proto indicates the size of the application window. All fields are required. | integer |
| heightPx | AssistantApiScreenCapabilitiesResolution | A Resolution proto indicates the size of the application window. All fields are required. | integer | |
| mSize | m_size is the smallest square box size to display a capital letter M so that the user can still easily understand it. | AssistantApiScreenCapabilitiesResolution | A Resolution proto indicates the size of the application window. All fields are required. | integer |
| nengSize | neng_size is the smallest square box size to display a letter 螚 (Neng, U+879A) so that the user can easily understand it. (Neng is a visually dense Chinese letter, and so may require a larger box than an M.) | AssistantApiScreenCapabilitiesResolution | A Resolution proto indicates the size of the application window. All fields are required. | integer |
| widthPx | The dimensions of the application window, in pixels. | AssistantApiScreenCapabilitiesResolution | A Resolution proto indicates the size of the application window. All fields are required. | integer |
| gestureCapabilities | A list of gestures that selina supports | AssistantApiSelinaCapabilites | The Soli capabilities on Elaine, including gestures and sleep sensing. go/dingo-dc-software Next ID: 4 | AssistantApiGestureCapabilities |
| selinaSupported | Whether the client supports selina. | AssistantApiSelinaCapabilites | The Soli capabilities on Elaine, including gestures and sleep sensing. go/dingo-dc-software Next ID: 4 | boolean |
| sleepSensingSupported | Whether the client can monitor sleep. This allows us to show sleep CUJ related information: go/TwilightDesign | AssistantApiSelinaCapabilites | The Soli capabilities on Elaine, including gestures and sleep sensing. go/dingo-dc-software Next ID: 4 | boolean |
| anyUserHasSetPersonalPhotos | Whether any user sets personal photos on this device. See go/ambient-setting-in-assistant-design. | AssistantApiSettingsAmbientSettings | boolean | |
| recentHighlightsEnabled | 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. | AssistantApiSettingsAmbientSettings | boolean | |
| showPersonalPhotoData | 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. | AssistantApiSettingsAmbientSettings | boolean | |
| showPersonalPhotos | Whether current user sets personal photos on this device. See go/ambient-setting-in-assistant-design. | AssistantApiSettingsAmbientSettings | boolean | |
| carSettingsCapabilities | Capabilities that are associated with Assistant Settings on auto surfaces. | AssistantApiSettingsAppCapabilities | These capabilities are associated with Assistant Settings on devices. | AssistantApiCarSettingsCapabilities |
| reissueQueryAfterMusicSetup | Whether the client supports reissuing query after setting up in Music Settings. | AssistantApiSettingsAppCapabilities | These capabilities are associated with Assistant Settings on devices. | boolean |
| supportsPaymentsSettingsUpdate | Whether the client supports updating payments setting. | AssistantApiSettingsAppCapabilities | These capabilities are associated with Assistant Settings on devices. | boolean |
| isAutoFramingEnabled | AssistantApiSettingsAutoFramingSettings | Settings pertaining to auto framing. See go/auto-framing-presentation. | boolean | |
| allowIncomingCalls | Whether this device is allowed to receive incoming PSTN calls. | AssistantApiSettingsCarrierCallDeviceSettings | Carrier related call settings on the device. | boolean |
| state | AssistantApiSettingsCommunicationsFilter | Specification of which communication features can be used. | String | |
| schedules | 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 | list(AssistantApiSettingsLabeledDowntimeSchedule) | |
| targets | The set of users of this device that will have these downtime settings applied. Must have at least one element. | 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 | list(String) |
| enabled | Enables/disables all the filters at the same time. For new devices or non-Cast devices this is always false. | 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 | boolean |
| featureFilters | The filters (feature restrictions) to apply when `enabled` is true. | 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 | AssistantApiSettingsFeatureFilters |
| targets | The set of users of this device that will have these settings applied. Must have at least one element. | 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 | list(String) |
| optInEnabled | Indicates whether the crash logs can be uploaded and the device logs can be enabled | AssistantApiSettingsDeviceLogsOptIn | boolean | |
| voiceEnrollmentStatus | Indicates whether the user’s voice has been successfully enrolled on this device. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| paymentsEnabled | DEPRECATED: Use DeviceCapabilities.OutputRestrictions.personal_data instead. Whether the user has enabled payments for this device. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| linkedUsers | Please do NOT use this field without prior approval from PWG. Users who have signed in onto this device, go/linked-users-in-pkg. | AssistantApiSettingsDeviceSettings | Next ID: 73 | list(AssistantApiSettingsLinkedUser) |
| ancillaryDeviceId | The additional device ids. Currently used only for ATV. go/project-yellowstone Note: This field is for internal (Within settings) use only. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsInternalAncillaryDeviceId |
| speakerIdEnabled | Indicates whether the user has enabled speaker-id for this device. See go/google-assistant-multi-user for more info on this project. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| faceEnrollmentStatus | Indicates whether the user’s face has been successfully enrolled on this device. See go/face-match-server-design for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| speechSettings | Speech/hotword detection related settings. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsSpeechSettings |
| colocationStatus | Status of colocation. go/co-location-work-v2 Note: this is a cache at the Assistant level. The source of truth is inside CastAuthenticationServer, which is only used for Home devices. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| lastUsedCoarseTimestamp | Coarsened hourly timestamp of when the device was last used. | AssistantApiSettingsDeviceSettings | Next ID: 73 | DateTime |
| supervisionSettings | Restrictions on how and when certain users can use a device. See go/home-ft-prd. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsDeviceSupervisionSettings |
| postalCode | AssistantApiSettingsDeviceSettings | Next ID: 73 | String | |
| humanFriendlyName | The human-friendly name of the cast device, e.g., my living room tv. This field is set by the user and already localized. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| homeGraphData | Holds the data that should be written to HomeGraph. Note: this field is not persisted in Assistant Settings storage. It is simply used for transporting data when client calls UpdateSettings. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsHomeGraphData |
| blueSteelEnabled | Indicates whether the user has enabled Blue Steel. See go/blue-steel for more info on this project. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| locationFeature | The feature proto of the location of the device. Note: client does not need to populate this. It will be auto-populated based on “address” field on server side. Currently, only “bound” and “type” are persisted, since the entire FeatureProto is too big. | AssistantApiSettingsDeviceSettings | Next ID: 73 | GeostoreFeatureProto |
| defaultAudioDeviceId | The identification of the default device which user want to output audio. See go/default-media-output-design for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiCoreTypesDeviceId |
| speechOutputSettings | Settings related to TTS output. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsSpeechOutputSettings |
| oauthClientId | OAuth client id for the device. This field is available for Assistant SDK devices. It is written when the device is registered to the user (AssistantSettingsUiService.LinkAssistantDeviceUi). When user revokes grant on the Assistant device, Assistant Devices Platform Service will receive Pubsub notification with OAuth client id for the revoked device, and we will compare that with this stored id to identity device to remove. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| marketplaceDisclosure | See go/marketplace-disclosure for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsMarketplaceDisclosure |
| locale | The locale for the device: language + region, i.e., en-US, ja-JP. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| linkedDeviceId | Stores pairing between different devices. See go/quartz-design-doc for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | list(AssistantApiCoreTypesDeviceId) |
| deviceModelId | The model ID of the device. This should be globally unique across manufactures/OEMs. Examples: “nest_cam_iq_2017”, “comcast_voice_box_2017”. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| verboseTtsForChromecastEnabled | Indicates whether to play verbose tts for Elementary on chirp. See: go/opa-cast-a11y-impl-design fore more info on this project. Note: this should probably be in SpeechOutputSetting below. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| shortenedAddress | A human-readable shortened address. This is usually the street address. Note: client does not need to populate this. It will be auto-populated based on “address” field on server side. Developers can use this field to avoid reading out the full address everytime. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| deviceBrand | The brand of the device, populated from DeviceOemParams. Examples: “google”, “samsung”. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| creationTimestampMs | The timestamp that the device is linked with the user in milliseconds. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| deviceId | The identification of the device. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiCoreTypesDeviceId |
| faceEnrollmentErrors | List of errors that happened during the face enrollment process if it failed. See go/face-match-enrollment-error for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | list(String) |
| faceMatchEnabled | Indicates whether the user has enabled Face Match for this device. See go/face-match-server-design for more info on this project. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| locationCoordinates | Coordinate information of the device location. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiCoreTypesLocationCoordinates |
| allowIncomingCalls | Whether this device is allowed to receive incoming calls. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| isCloudSyncDevice | Indicates whether the device is also managed through HA cloud sync. go/ha-dev-guide | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| politeMode | Specify whether polite mode is enabled for this device. See go/pretty-please-dd. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsPoliteMode |
| hotwordThresholdAdjustmentFactor | HotwordThresholdAdjustmentFactor contains threshold_adjustment_factor, and it’s validity. TAF is a measure of adjustment applied to the hotword threshold as a result of go/autotune. Currently, this is updated from query_settings_frame, but if we move to updating it from the client, this could also contain TAFs as a result of Hotword Sensitivity, in addition to Autotune. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsHotwordThresholdAdjustmentFactor |
| autoFramingSettings | Auto framing settings associated with a device. See go/auto-framing-presentation. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsAutoFramingSettings |
| onDeviceAppSettings | Device specific app related settings. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsOnDeviceAppSettings |
| kidsMode | Specifies if kids-mode is enabled for the device. See go/aff-parentalsupervision-dd. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsKidsMode |
| gcmSettings | Stores GCM info associated with a device. See go/quartz-design-doc for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsGcmSettings |
| tetheredInfo | Presence indicates a tethered wearable. go/wearable-device-ids. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsTetheredInfo |
| hotwordSensitivity | The level of hotword sensitivity. go/hotword-sensitivity-prd | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| reauthTrustedDeviceSettings | Trusted device preferences Assistant reauth. go/assistant-reauth-verify-skip. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsReauthTrustedDeviceSettings |
| ambientSettings | Ambient settings contains the configuration of Photo Frame on DG device. This field relies on IMAX service to do the update, sync happenes after user updates IMAX device settings or a device registers in CloudCastDevice. So it’s more like a cached version instead of definitive source-of-truth. More details at go/ambient-setting-in-assistant-design. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsAmbientSettings |
| hospitalityModeStatus | Indicates whether the device is currently in Hospitality mode. go/hospitality-mode-design. This is moved to a per user setting in assistant settings. ref. go/hospitality-settings-v2 | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsHospitalityMode |
| masqueradeMode | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsMasqueradeMode | |
| personalizationMetadata | Metadata about how personalization settings were configured. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsPersonalizationMetadata |
| defaultVideoDeviceId | The identification of the default device which user want to output video. Note that, we don’t fallback to this for audio playback when default_audio_device_id is not set. See go/default-media-output-design for more info. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiCoreTypesDeviceId |
| optInStatus | Specifies if device logs and crashes can be captured during SendFeedback | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsDeviceLogsOptIn |
| surfaceType | The type of assistant surface. Only use this field when device type is ASSISTANT. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiCoreTypesSurfaceType |
| truncatedLocalNetworkId | Local network ID of the device (truncated to obfuscate devices and households globally). This is a temporary signal to determine proximity of Assistant devices in a house (HGS place). | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| vmLastUsedCoarseTimestamp | Coarsened hourly timestamp of when the user was last verified by VoiceMatch on this device. This is used for enforcing VoiceMatch model TTL. go/voicematch-pdd-ttl | AssistantApiSettingsDeviceSettings | Next ID: 73 | DateTime |
| ackStatus | LINT.ThenChange(//depot/google3/assistant/ui/assistant_device_settings_ui.proto) | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| deviceModelRevision | The Device Platform Service lookup revision. (go/device-model-revision) For 1p devices, and most 3p devices with no custom feature, this should be always 0, which means no lookup needed. For 3p devices with custom assistant feature, this is provided directly by OEM as incremental (e.g. 1, 2, 3, …) | AssistantApiSettingsDeviceSettings | Next ID: 73 | integer |
| notificationProfile | Information about how to send the user a notification. This won’t be populated for fb-conv users (allo group chat users). | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsNotificationProfile |
| voiceInputEnabled | A boolean indicates whether voice input (mic-button, hotword, etc) is enabled. | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| city | city and postal_code are sent to third party AoG Apps as location when permission is granted for precise or coarse location. https://developers.google.com/actions/reference/rest/Shared.Types/Permission city and postal_code have the same description as in Proto Postal Address: https://cs.corp.google.com/piper///depot/google3/location/country/postaladdress.proto city corresponds to locality_name, postal_code corresponds to postal_code_number. These two fields are set in assistant_settings_service by AddressConverter. https://cs.corp.google.com/piper///depot/google3/location/addressformatter/public/addressconverter.h See go/aog-i18n-address-parse for more information | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| dusi | Only valid for ATV. Stores the android DUSI for the corresponding user. More details: go/auto-logout-on-unlink. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| timeZone | Device time zone. It’s mainly used for a one-time notification for new users when they just bought and activated their devices. They may not have used Search or Assistant before, so their timezone info may not available elsewhere when we want to send a notification. This should be used as a fallback only when other timezone sources such as assistant_settings:user_attribute#inferred_user_timezone are not available. Also, when both |time_zone| and |location| are set, the |location| should be preferred to derive the most up to date timezone. This info directly comes from the device through early device setting recording mechanism. See more details at go/early-device-setting-recording. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiTimeZone |
| lastCastRegistrationTimestamp | Device’s latest registration timestamp provided by Cast side. This field is not necessarily up to date. The update frequency is defined in last_registration_update_frequency_in_days field of AssistantConfig in java/com/google/chrome/dongle/common/proto/home_assistant_config.proto. go/cast-last-registration-time | AssistantApiSettingsDeviceSettings | Next ID: 73 | DateTime |
| crossSurfaceAvailability | Availability of this device for Assistant Cross-surface handoffs. (go/assistant-cross-surface) | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsDeviceSettingsCrossSurfaceAvailability |
| type | The type of the device. Note: this should only be used for grouping devices for UI presentation purpose. Use |capabilities| to decide what the device can do. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| aliasName | The alias names of the device, e.g. my living room tv, tv, living room and etc., which user will usually use to refer to the device in addition to human_friendly_name. It can help speech biasing and query understanding. This field is set by the user and already localized. | AssistantApiSettingsDeviceSettings | Next ID: 73 | list(String) |
| homeGraphId | The home graph ID that can be used to lookup the corresponding entry in HomeGraph. go/home-graph. Note: when this field is empty, it doesn’t necessarily mean that the device is not in home graph. It just means that Assistant doesn’t know about the mapping. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| address | A human-readable address string for the location; generally a one-line address such as “34 Masonic Ave, San Francisco CA 94117, United States”. Set this field to empty string for deletion, in which case the rest of the location related fields below will be cleared as well. | AssistantApiSettingsDeviceSettings | Next ID: 73 | String |
| internalVersion | Internal version of the DeviceSettings for measurement of the DeviceSettings mutation race conditions. See go/consistent-assistant-settings-update. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiSettingsInternalVersion |
| isDeviceActivationCacheEnabled | When true, the user has explicitly allowed audio and visual data collection on this device | AssistantApiSettingsDeviceSettings | Next ID: 73 | boolean |
| capabilities | Describes roughly what a device is capable of doing and metadata around those capabilities. Note: this includes device limitations as well as user configurable settings. | AssistantApiSettingsDeviceSettings | Next ID: 73 | AssistantApiDeviceCapabilities |
| lastKnownClientLocale | Last known locale of the client. | AssistantApiSettingsDeviceSettingsCrossSurfaceAvailability | String | |
| lastParamsWriteTimestamp | This is the timestamp when the AssistantRequestParams (in ASSISTANT_SNAPSHOT corpus) were last written for this device. | AssistantApiSettingsDeviceSettingsCrossSurfaceAvailability | DateTime | |
| downtimeSettings | Specification of times that a device shouldn’t respond to certain users. See go/home-ft-prd. | AssistantApiSettingsDeviceSupervisionSettings | AssistantApiSettingsDeviceDowntimeSettings | |
| featureFilters | Restrictions on features that certain users can access on a device. See go/home-ft-prd. | AssistantApiSettingsDeviceSupervisionSettings | AssistantApiSettingsDeviceFeatureFilters | |
| enabled | True if downtime should be enabled during this period. | 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. | boolean |
| endTime | Time of day that this downtime period should end. Required. If end_time > start_time, end_time is relative to start_day. Otherwise, end_time is relative to the day after start_day. For example, start_day: MONDAY, start_time: 9 p.m., end_time: 6 a.m. means that the downtime period starts at 9 p.m. on Monday and ends at 6 a.m. on Tuesday. | 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. | GoogleTypeTimeOfDay |
| startDay | The day of the week when this downtime period starts. Required. | 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. | String |
| startTime | Time of day that this downtime period should start. Required. | 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. | GoogleTypeTimeOfDay |
| enabled | True if this downtime schedule should be enabled. | 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. | boolean |
| periods | Downtime entries for the days of the week, in no particular order. There can be at most one period defined for each day of the week. Days of the week with no explicit period defined are treated as disabled, so the device is available all day (modulo an end time that may spill over from the previous day). | 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. | list(AssistantApiSettingsDowntimePeriod) |
| allowKnockKnock | True if Duo Knock Kncok feature is enabled on the device. | AssistantApiSettingsDuoCallDeviceSettings | Duo related call settings on the device. Next ID: 5 | boolean |
| shouldBeLinked | Boolean indicating if user has explicitly marked this device to be linked or not. This bit is used in case where unexpected errors occur and we have to check for account/device status and mark the device linked after verification. | AssistantApiSettingsDuoCallDeviceSettings | Duo related call settings on the device. Next ID: 5 | boolean |
| state | The call state of the device (i.e. whether a Duo call account has been setup on the device). | AssistantApiSettingsDuoCallDeviceSettings | Duo related call settings on the device. Next ID: 5 | String |
| talkbackEnabled | Client device settings: settings which are populated by client to give to duocore. TalkBack is an accessibility service that helps blind and vision-impaired users interact with their devices. Indicates whether talkback is enabled for the device. Note: this is per device settings currently filled by client for all users. | AssistantApiSettingsDuoCallDeviceSettings | Duo related call settings on the device. Next ID: 5 | boolean |
| communicationsFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsCommunicationsFilter | |
| musicFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsMusicFilter | |
| newsFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsNewsFilter | |
| podcastFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsPodcastFilter | |
| searchFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsSearchFilter | |
| thirdPartyAppsFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsThirdPartyAppsFilter | |
| videoFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsVideoFilter | |
| webviewFilter | AssistantApiSettingsFeatureFilters | Specification of which assistant features are allowed for a particular device or user account. | AssistantApiSettingsWebviewFilter | |
| gcmId | AssistantApiSettingsGcmSettings | String | ||
| gcmPackage | AssistantApiSettingsGcmSettings | String | ||
| agentId | Agent ID, aka project ID. Used as the AgentDeviceId.agent_id of device when calling Home Graph Service. | AssistantApiSettingsHomeGraphData | Next ID: 8 | String |
| attributes | See go/ha-dev-guide and HomeGraphItem.attribute in //assistant/verticals/homeautomation/proto/home_graph.proto | AssistantApiSettingsHomeGraphData | Next ID: 8 | map |
| deviceId | Device ID, used as AgentDeviceId.device_id of device when calling Home Graph Service. | AssistantApiSettingsHomeGraphData | Next ID: 8 | String |
| deviceType | HGS device type. See java/com/google/home/graph/service/config/protoconf.pi for the exhaustive list of type strings. | AssistantApiSettingsHomeGraphData | Next ID: 8 | String |
| shouldWriteToHomeGraph | Whether device data should be written to Home Graph via Assistant device_settings. Assistant SDK and Google Home write their devices into Home Graph through AssistantSettingsService, while Home Automation Partner devices (e.g. SmartThings, Philips Hue, Nest, TP-Link, etc.) don’t need to be written to Home Graph through AssistantSettingsService. This field decides whether AssistantSettingsService writes devices to Home Graph or not. | AssistantApiSettingsHomeGraphData | Next ID: 8 | boolean |
| supportedTraits | Supported traits of the device. See java/com/google/home/graph/service/config/protoconf.pi for the exhaustive list of trait-strings. | AssistantApiSettingsHomeGraphData | Next ID: 8 | list(String) |
| supportsDirectResponse | Whether the device supports direct response. See HomeGraphItem.supports_direct_response in //assistant/verticals/homeautomation/proto/home_graph.proto | AssistantApiSettingsHomeGraphData | Next ID: 8 | boolean |
| cardConfig | Config for Hospitality UI modules. | AssistantApiSettingsHospitalityCardSettings | list(AssistantApiSettingsHospitalityCardSettingsCardConfig) | |
| showMediaTapGestureTutorial | Toggle media tap gesture tutorial card. | AssistantApiSettingsHospitalityCardSettings | boolean | |
| showPhotoSwipeGestureTutorial | Toggle photo swipe gesture tutorial card. | AssistantApiSettingsHospitalityCardSettings | boolean | |
| youtubeCardConfig | Config for YouTube video cards. | AssistantApiSettingsHospitalityCardSettings | list(AssistantApiSettingsHospitalityCardSettingsYouTubeCardConfig) | |
| activeActionRequired | Whether the UI module requires user action. If true, the UI module can peek on to the top of Ambient. See SmartDisplayModuleState::ACTIVE_ACTION_REQUIRED. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | boolean |
| dismissable | Whether the UI module is dismissable. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | boolean |
| effectiveTime | The time that the module is effective and visible to the user. If not set, the module is effective immediately. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | AssistantApiTimestamp |
| expiryTime | The time that the module is expired and invisible to the user. If not set, the module never expires. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | AssistantApiTimestamp |
| imageUrl | The image URL for the UI module. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | String |
| moduleId | Module ID. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | String |
| payloadQuery | Payload query to the partner AoG action when user responds to UI Module, e.g. “Tell the hotel how my stay is going”. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | String |
| title | Title of the message to be shown to user at the top of the UI Module. | AssistantApiSettingsHospitalityCardSettingsCardConfig | Configuration for hospitality card. | String |
| imageUrl | URL of image to go on card. The URL must be a public link accessible from ZeroState. | AssistantApiSettingsHospitalityCardSettingsYouTubeCardConfig | Configuration for YouTube video card (Stargazer tile). | String |
| playlistId | ID of YouTube playlist to play on card tap. A playlist is used instead of a single video id to avoid autoplaying related videos. The playlist and the videos it contains must be public or unlisted to be accessible from ZeroState. | AssistantApiSettingsHospitalityCardSettingsYouTubeCardConfig | Configuration for YouTube video card (Stargazer tile). | String |
| text | Text on card (i.e., video title). | AssistantApiSettingsHospitalityCardSettingsYouTubeCardConfig | Configuration for YouTube video card (Stargazer tile). | String |
| aogContextId | List of AOG app context ids that are linked to this device. These apps will have access to the structure information for the device. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | list(String) |
| aogInvocationPhrase | Invocation phrase for hotel’s AoG action. Used for ZS promotion card and “talk to my hotel” rewrites. Setting this to an empty value will mark it unset. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | String |
| branding | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiSettingsHospitalityModeBranding | |
| cardSettings | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiSettingsHospitalityCardSettings | |
| deviceClearRequest | The time when we received a request to reset the device. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiTimestamp |
| dialogTtlOverrideMicros | Should the dialog have a shorter ttl. See go/ipp-consumer-prd#heading=h.ibu9b1ysdl4t and go/interpreter-device-clear#bookmark=id.hw8ey1bzjadn for context. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | String |
| enterpriseId | Identifier for the enterprise which owns the device. Setting this to an empty value will mark it unset. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | String |
| hospitalityModeEnabled | Indicates whether this device is in the hospitality mode. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | boolean |
| lastDeviceClear | Last time the device was cleared and placed in hospitality mode. Will be set when the switch is toggled on and reset when a guest checks out. On the device this triggers removing alarms, timers, etc. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiTimestamp |
| lastModifiedTimestamp | Indicates when hospitality settings were last updated. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiTimestamp |
| lastWelcomed | Last time the welcome message was played for the guest. If last_welcomed < welcome_request, the message should be replayed and this time set. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiTimestamp |
| manualResetRequired | Indicates whether or not the device must be reset manually (by voice or touch), as opposed to being automatically reset. go/hospitality-manual-reset | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | boolean |
| promotedLanguages | In order promoted languages for interpreter devices. This represents languages by BCP-47 language strings, such as “en”, “en-US”, “fr”, “fr-CA”, “sr-Latn”, “zh-Hans-CN”, “zh-Hant-HK”,etc. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | list(String) |
| type | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | String | |
| verbalResetSupported | Whether we allow users to initiate clearing the device verbally. We generally allow this for private devices and not for public ones. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | boolean |
| welcomeRequest | The time when we received a request to welcome the user. | AssistantApiSettingsHospitalityMode | Hospitality mode config for the current device. go/hospitality-mode-design. Next ID: 17 | AssistantApiTimestamp |
| displayName | Brand display in the UI | 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 | String |
| displayNameForLanguage | Brand display in the UI for languages that the enterprise has a localized name that is different from its global branding name. For example, Hilton is ‘ヒルトン’ in Japanese and ‘希爾頓’ in Chinese. The keys are hospitality supported display locales, e.g. en, ja-JP, etc, defined in experiment parameter Hospitality__hospitality_display_supported_locales. | 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 | map |
| largeLogoUrl | 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 | String | |
| smallLogoUrl | 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 | String | |
| isValid | Currently, is_valid is set to false whenever the TAF is not an Autotune aware value. This includes hotword sensitivity users, or devices not eligible for autotune. | AssistantApiSettingsHotwordThresholdAdjustmentFactor | HotwordThresholdAdjustmentFactor contains threshold_adjustment_factor, and it’s validity. value should only be considered when is_valid = true. | boolean |
| value | AssistantApiSettingsHotwordThresholdAdjustmentFactor | HotwordThresholdAdjustmentFactor contains threshold_adjustment_factor, and it’s validity. value should only be considered when is_valid = true. | integer | |
| deviceId | Contains device ids known to devices. eg. For ATV, it contains client_instance_id and cast_id. | AssistantApiSettingsInternalAncillaryDeviceId | Represents supporting device ids. | AssistantApiCoreTypesDeviceId |
| generationTime | Contains the timestamp when this version was generated. | AssistantApiSettingsInternalVersion | Represents a version of a specifit setting, e.g. DeviceSettings. | DateTime |
| id | Integer value of the version, it is a monotonically increasing number and starts at 0. On every update it is incremented by 1. | AssistantApiSettingsInternalVersion | Represents a version of a specifit setting, e.g. DeviceSettings. | String |
| kidsModeEnabled | AssistantApiSettingsKidsMode | Kids mode config for the current device. go/aff-parentalsupervision-dd | boolean | |
| obfuscatedGaiaId | Identifier of the account currently specified to be used with kids mode. | AssistantApiSettingsKidsMode | Kids mode config for the current device. go/aff-parentalsupervision-dd | String |
| displayName | User-provided name for this schedule. | AssistantApiSettingsLabeledDowntimeSchedule | String | |
| schedule | AssistantApiSettingsLabeledDowntimeSchedule | AssistantApiSettingsDowntimeSchedule | ||
| castLinkingTime | Time of linking of the device with the user provided by Cast. | AssistantApiSettingsLinkedUser | Represents the profile of the user who has signed in onto this device. Next id: 5 | DateTime |
| Primary email address of the user. | AssistantApiSettingsLinkedUser | Represents the profile of the user who has signed in onto this device. Next id: 5 | String | |
| gaiaId | AssistantApiSettingsLinkedUser | Represents the profile of the user who has signed in onto this device. Next id: 5 | String | |
| names | Supports features which depend on profile name, when no matching contact is found. | AssistantApiSettingsLinkedUser | Represents the profile of the user who has signed in onto this device. Next id: 5 | list(AppsPeopleOzExternalMergedpeopleapiName) |
| confirmed | True if the user has confirmed the marketplace disclosure. | AssistantApiSettingsMarketplaceDisclosure | boolean | |
| timestampMs | The time user confirmed the marketplace disclosure. | AssistantApiSettingsMarketplaceDisclosure | String | |
| lastEnterGuestModeTimestamp | AssistantApiSettingsMasqueradeMode | Guest mode for the current device. go/assistant-guest-mode-summary | AssistantApiTimestamp | |
| lastExitGuestModeTimestamp | AssistantApiSettingsMasqueradeMode | Guest mode for the current device. go/assistant-guest-mode-summary | AssistantApiTimestamp | |
| masqueradeModeEnabled | AssistantApiSettingsMasqueradeMode | Guest mode for the current device. go/assistant-guest-mode-summary | boolean | |
| availableProviders | Providers available at the time user updated settings. | AssistantApiSettingsMusicFilter | Specification of which music features can be used. | list(String) |
| providerFilterState | Represents the state for the music provider filter. | AssistantApiSettingsMusicFilter | Specification of which music features can be used. | String |
| state | AssistantApiSettingsMusicFilter | Specification of which music features can be used. | String | |
| whitelistedProviders | Contains the list of whitelisted music providers. | AssistantApiSettingsMusicFilter | Specification of which music features can be used. | list(String) |
| state | AssistantApiSettingsNewsFilter | Specification of which news features can be used. | String | |
| alloNotificationProfile | Each device can have only one type of notification profile. | AssistantApiSettingsNotificationProfile | AssistantApiSettingsNotificationProfileAlloNotificationProfile | |
| botSendToken | The send token of the conversation with the user. | AssistantApiSettingsNotificationProfileAlloNotificationProfile | ChatBotPlatformBotSendToken | |
| id | The fireball id of this user. | AssistantApiSettingsNotificationProfileAlloNotificationProfile | ChatBotPlatformFireballId | |
| carrierCallDeviceSettings | On device carrier call related settings. | AssistantApiSettingsOnDeviceAppSettings | AssistantApiSettingsCarrierCallDeviceSettings | |
| duoCallDeviceSettings | On device duo call related settings. | AssistantApiSettingsOnDeviceAppSettings | AssistantApiSettingsDuoCallDeviceSettings | |
| faceMatch | AssistantApiSettingsPersonalizationMetadata | String | ||
| personalResults | AssistantApiSettingsPersonalizationMetadata | String | ||
| voiceMatch | AssistantApiSettingsPersonalizationMetadata | String | ||
| state | AssistantApiSettingsPodcastFilter | Specification of which podcast features can be used. | String | |
| politeModeEnabled | AssistantApiSettingsPoliteMode | Polite mode config for the current device. go/polite-mode-dd | boolean | |
| neverAskAgain | If true, don’t ask user to trust this device again. | AssistantApiSettingsReauthTrustedDeviceSettingsTrustSettings | Next id: 6 | boolean |
| neverAskExpirationTimestamp | DEPRECATED: Use never_ask_again instead. Expiration timestamp of “never ask again” status. If this field is set and is later than current timestamp, we should NOT ask the user whether they’d like to trust this device. | AssistantApiSettingsReauthTrustedDeviceSettingsTrustSettings | Next id: 6 | DateTime |
| trustDeviceExpirationTimestamp | Expiration timestamp of “trusted” status. If this field is set and is later than current timestamp, we can consider this device to be trusted. | AssistantApiSettingsReauthTrustedDeviceSettingsTrustSettings | Next id: 6 | DateTime |
| state | AssistantApiSettingsSearchFilter | Specification of which search features can be used. | String | |
| speechOutput | AssistantApiSettingsSpeechOutputSettings | Settings related to TTS output. | String | |
| continuedConversationEnabled | Indicates whether Continued Conversation is enabled for this device. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| deviceModelType | Stores the device model type e.g Pixel. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | String |
| dspAvailable | Whether the device has DSP chip to enable always on hotword detection. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| hotwordInNavigationEnabled | Whether hotword has been enabled by the user during navigation. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | String |
| hotwordSetting | Stores hotword setting status for the locales which don’t support voice match. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | String |
| lockscreenEnabled | Whether pin/pattern lockscreen has been enabled by the user. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| opaEligibilityState | Stores if Assistant is available for the user’s device/locale, where Enabled means it is available and disabled means it is not. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | String |
| opaEligible | Stores if Assistant is available for the user’s device/locale. Deprecated as bools do not give accurate true/false ratios due to old clients reporting the default value. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| sdkVersion | Stores the Android SDK version. This comes from android.os.Build.VERSION.SDK_INT. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | integer |
| speakerIdModelPresent | Whether speaker ID model is present for the user. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| speakerIdRecognitionEnabled | Indicates whether the user has enabled speaker-id (fromAnyScreen/alwaysOn) for this device. Deprecated – use voice_match_setting instead | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| trustedVoiceEnabled | Indicates whether the user has enabled trusted voice for this device. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| unlockWithHotwordAvailable | A bool indicating whether device supports unlocking device with hotword. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| userMigratedToDeclined | Stores if user was migrated from undecided to declined as apart of Mariko project. Used for potential growth targeting. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | boolean |
| voiceMatchSetting | Stores the hotword/voice match setting status for the locales which support voice match. | AssistantApiSettingsSpeechSettings | Settings related to speech detection. See go/hotword-settings-on-cloud for more info. Next ID: 16 | String |
| primaryHostDeviceId | 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. | AssistantApiSettingsTetheredInfo | String | |
| state | AssistantApiSettingsThirdPartyAppsFilter | Specification of which third party apps can be used. | String | |
| autoplayToggleState | State that indicates whether autoplay is enabled for youtube videos. | AssistantApiSettingsVideoFilter | Specification of which video features can be used. | String |
| availableProviders | Providers available at the time user updated settings. | AssistantApiSettingsVideoFilter | Specification of which video features can be used. | list(String) |
| providerFilterState | Represents the state for the video provider filter. | AssistantApiSettingsVideoFilter | Specification of which video features can be used. | String |
| state | AssistantApiSettingsVideoFilter | Specification of which video features can be used. | String | |
| whitelistedProviders | Contains the list of whitelisted video providers. | AssistantApiSettingsVideoFilter | Specification of which video features can be used. | list(String) |
| jasperWebviewConsent | Indicates if user has consented Jasper warning message. | AssistantApiSettingsWebviewFilter | Specification of which webview features can be used. | boolean |
| state | AssistantApiSettingsWebviewFilter | Specification of which webview features can be used. | String | |
| method | AssistantApiSignInMethod | The method of sign in which the client supports. | String | |
| signInRequired | Make Google sign-in mandatory for using Google Assistant on the device. | AssistantApiSignInMethod | The method of sign in which the client supports. | boolean |
| supportsHotwordSensitivity | Whether the device supports different levels of hotword sensitivity. go/hotword-sensitivity-prd | AssistantApiSodaCapabilities | Capabilities related to SODA (Speech On-Device API). Next ID: 5 | boolean |
| supportsSimpleStop | Whether Simple Stop (go/simple-stop) is enabled on the device. Simple stop allows users to stop firing alarms and timers by just saying “stop” without first saying the hotword. | AssistantApiSodaCapabilities | Capabilities related to SODA (Speech On-Device API). Next ID: 5 | boolean |
| supportsSpeakerId | Whether the device supports speaker-id (speaker identification based on hotword and/or spoken query – go/speaker-id). Note: there are existing devices that support speaker-id but does not have this capability set. Not having this field populated doesn’t necessarily mean the device doesn’t support speaker-id. | AssistantApiSodaCapabilities | Capabilities related to SODA (Speech On-Device API). Next ID: 5 | boolean |
| supportsWarmWords | Whether the device supports WarmWords (go/warm-words-framework). | AssistantApiSodaCapabilities | Capabilities related to SODA (Speech On-Device API). Next ID: 5 | boolean |
| appCapabilities | IMPORTANT: Only one of AppCapabilities and AppCapabilitiesDelta should be in the SoftwareCapabilities. In the edge case if the client sends up both AppCapabilities and AppCapabilitiesDelta, AppCapabilitiesDelta is ignored. Complete list of app capabilities. | 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 | list(AssistantApiAppCapabilities) |
| appCapabilitiesDelta | Incremental update for app capabilities. | 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 | list(AssistantApiAppCapabilitiesDelta) |
| carAssistantCapabilities | Capabilities related to Assistant on Auto surfaces. | 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 | AssistantApiCarAssistantCapabilities |
| clockCapabilities | Capabilities related to clock functionality, like alarms, timers, etc. | 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 | AssistantApiClockCapabilities |
| conversationVersion | A top-level version of Conversation protocol where the versions are explicitly defined at go/conversation-versions. | 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 | AssistantApiSupportedConversationVersion |
| crossDeviceExecutionCapabilities | For torus x-device execution support | 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 | AssistantApiCrossDeviceExecutionCapability |
| gacsCapabilities | 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 | AssistantApiGacsCapabilities | |
| gcmCapabilities | 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 | AssistantApiGcmCapabilities | |
| liveTvChannelCapabilities | Capabilities related to live TV channels. | 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 | AssistantApiLiveTvChannelCapabilities |
| oemCapabilities | List of actions OEM supports. This includes built-in actions and custom actions. | 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 | AssistantApiOemCapabilities |
| onDeviceAssistantCapabilities | on-device Assistant capabilities | 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 | AssistantApiOnDeviceAssistantCapabilities |
| onDeviceSmartHomeCapabilities | Capability bits for on-device Smart Home. go/framework-for-local-semex | 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 | AssistantApiOnDeviceSmartHomeCapabilities |
| onDeviceStorageCapabilities | Reflects the storage capabilities on the device. | 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 | AssistantApiOnDeviceStorageCapabilities |
| operatingSystem | The operating system of the device. | 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 | String |
| orderedLiveTvProviders | An ordered list containing the live tv providers available in the client. The order of the providers reflects the ranking in the client and will be respected by server as well. | 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 | list(AssistantApiLiveTvProvider) |
| robinCapabilities | Capabilities of Robin client. | 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 | AssistantApiRobinCapabilities |
| selinaCapabilities | The Soli capabilities on Elaine. go/dingo-dc-software | 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 | AssistantApiSelinaCapabilites |
| settingsAppCapabilities | 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 | AssistantApiSettingsAppCapabilities | |
| supportedClientOp | 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 | list(AssistantApiSupportedClientOp) | |
| supportedFeatures | 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 | AssistantApiSupportedFeatures | |
| supportedMsgVersion | 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 | AssistantApiSupportedProtocolVersion | |
| supportedProviderTypes | 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 | AssistantApiSupportedProviderTypes | |
| surfaceProperties | 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 | AssistantApiSurfaceProperties | |
| dspAvailable | A bool indicating whether device supports dsp based hotword detection. | AssistantApiSpeechCapabilities | DEPRECATED These capabilities are associated with speech detection on devices. | boolean |
| unlockWithHotwordAvailable | A bool indicating whether device supports unlocking device with hotword. | AssistantApiSpeechCapabilities | DEPRECATED These capabilities are associated with speech detection on devices. | boolean |
| clickImpersonationSupported | Whether client supports user impersonation on suggestion chip click. go/suggestion-click-impersonation | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| debugDataSupported | Whether client supports suggestions debug data to be displayed. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| drlHistoryChipSupported | Whether DRL history chip is supported. Related bug: http://b/241837879, http://b/171854732 Design doc: http://go/panthera-history-chip-dd DRL history chip was originally rolled out to Panthera in http://google3/googledata/experiments/mobile/agsa/studies/agsa_nga/opa_panthera_one_input_ui_launch.gcl?l=55&rcl=384682900. We plan to roll it out to NGA and TNG. drl_history_chip_supported bit specifies whether the client support (and should have) DRL history chip. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| escapeHatchSupported | Whether client supports escape hatches aka post execution suggestions go/nga-escape-hatch-prd | AssistantApiSuggestionsSupport | Next ID: 18 | String |
| executedTextSupported | Whether the client can rewrite suggestion query text into executed text, if the latter is present. If this feature is disabled, the rewrite happens in Assistant Server. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| executionContextSupported | Whether the client supports passing back `execution_context` from |assistant.api.client_op.SuggestionProcessingParams| when the suggestion is clicked or spoken. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| featureSpecificActionSupport | Whether the client supports features in |SuggestionFeatureSpecificAction|. | AssistantApiSuggestionsSupport | Next ID: 18 | AssistantApiFeatureSpecificActionSupport |
| featureSpecificAppActionsNotificationSupported | Whether the client supports handling App Actions’ notification when the suggestion is clicked. This will allow the server to populate the `app_actions_notification_data` extension field from |SuggestionFeatureSpecificAction| proto message. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| multiStepTrySayingSupported | Whether the multi-step try saying suggestion feature is supported. dd: go/tng-multi-step-simplified | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| ruleIdInExecutionContextSupported | Whether the rule_id field in the execution_context is supported. This is a temporary workaround to be able to identify clicks on Person entity suggestions on Sabrina and is expected to be eventually deprecated. TODO(b/185517153) : Deprecate (but do not delete) once click tracking is correctly sent up from the Katniss client. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| showExecutedTextSupported | Whether the client can show executed_text after the click on the suggestion chip. Must be set to false on TNG. TNG disregards |SuggestionProcessingParams.show_executed_text| field and always treats it as if |show_executed_text=true|. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| showTranslationSupported | Whether the client can show chip as (text | translation). go/lang-partner-doc | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| supportedDisplayTargets | A list of suggestions display targets supported by this client. If unset only DEFAULT SuggestionDisplayTarget is supported. | AssistantApiSuggestionsSupport | Next ID: 18 | list(AssistantApiSuggestionsSupportDisplayTargetSupport) |
| widgetDataSupported | Whether client supports widget suggestion chip to be displayed. | AssistantApiSuggestionsSupport | Next ID: 18 | boolean |
| executedTextSupported | Whether the client can rewrite suggestion query text into executed text, if the latter is present for the display target. | AssistantApiSuggestionsSupportDisplayTargetSupport | boolean | |
| headerTextSupported | Whether PresentationParams.header_text is supported for the display target. | AssistantApiSuggestionsSupportDisplayTargetSupport | boolean | |
| repressImpressionSupported | Whether Suggestion.repress_impression is supported. If not repressed suggestions are not returned. | AssistantApiSuggestionsSupportDisplayTargetSupport | boolean | |
| target | Display target that is supported. | AssistantApiSuggestionsSupportDisplayTargetSupport | String | |
| sunriseSimulationSupported | If true, the device can slowly brighten the screen and simulate sunrise experience. Alarms with sunrise field enabled can be set on this device. | AssistantApiSunriseFeaturesSupport | boolean | |
| clientOpName | This should be the same as the name of the SemanticClientOp that is supported. | AssistantApiSupportedClientOp | These are the set of ClientOps that are supported by the device. | String |
| clientOpProperties | The properties associated with the ClientOp. This proto should be associated with the client_op_name. | AssistantApiSupportedClientOp | These are the set of ClientOps that are supported by the device. | AssistantApiProtobuf |
| supportedExecution | AssistantApiSupportedClientOp | These are the set of ClientOps that are supported by the device. | AssistantApiSupportedClientOpSupportedExecution | |
| version | A version of 0 is the equivalent to not having support for that client_op type. Note that a client_op is also unsupported if it is not included at all in the list of supported client_ops. | AssistantApiSupportedClientOp | These are the set of ClientOps that are supported by the device. | integer |
| supportsPartialFulfillment | ClientOp execution supports special rendering behavior while the user is in the middle of expressing their query. This behavior includes: 1) New partial output always over-writes prior partial output. 2) Canceling the interaction removes partial fulfilment from any user visible interaction history. If this is true, whether to apply the special rendering behavior will be determined by PartialFulfillmentRenderingParams. More details can be found at go/ma-natcon-pf-api. | 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. | boolean |
| supportsSynchronousExecution | Client can support synchronous execution of the client op. For tts.OUTPUT client op it means that client would honor |synchronous_playback_args| argument. Please see more at go/synchronous-sounds-design. | 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. | boolean |
| supportsConversationProtocol | Whether conversation protocol is supported explicitly. If true, SingleDeviceCapabilityChecker::SupportsConversationProtocol will always return true. | 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. | boolean |
| version | The supported version number. | 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. | integer |
| readNotificationSummarizationSupported | Whether the client supports message summarization. Deprecated, use message_summary_support instead. | 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 | boolean |
| fitnessFeatureSupport | Information about what support this device has for fitness. | 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 | AssistantApiFitnessFeatureSupport |
| masqueradeModeSupported | Whether the device supports masquerade mode (go/masquerade). | 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 | boolean |
| appControlSupport | The client information for app control support. More details in: go/acaia. | 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 | AssistantApiAppControlSupport |
| gearheadNotificationSourceSupported | Whether the client supports the Gearhead message notification source, in which case notification-related operations can access it. | 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 | boolean |
| parentalControlsSupported | Whether or not the client supports enabling parental controls. When a device to supports parental controls, it has the software necessary to store the relevant information required for parental controls to work. This information includes a boolean “enabled bit” as well as the obfuscated gaia ID of the kid account selected for use with parental controls. Devices supportings kids mode send this information to S3 via S3ClientInfo in every request. See go/aff-kidsproduct for details. | 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 | boolean |
| mediaControlSupport | Information about how client handles media controls (play, pause, skip …) | 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 | AssistantApiMediaControlSupport |
| sunriseFeaturesSupport | Whether the client supports the sunrise screen brightening feature before the alarm fires. This is used to indicate whether sunrise alarms can be set on the device. http://cs/symbol:assistant.api.core_types.governed.RingtoneTaskMetadata.GentleWakeInfo | 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 | AssistantApiSunriseFeaturesSupport |
| shLockScreenSupported | Whether the client supports SmartHome lock screen logic (i.e. on Tangor). | 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 | boolean |
| fluidActionsSupport | Fluid Actions features supported by the client. If this field is not set in the incoming request, it could mean that the client does not support Fluid Actions. Alternatively, it could mean that the client supports Fluid Actions, but syncs state with server using the old protocol, namely ConversationStateParams. When b/140733618 is resolved, Surface Adaptation Layer will add this field for old clients that support Fluid Actions framework. | 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 | AssistantApiFluidActionsSupport |
| bypassMsgNotificationDismissal | Whether or not Assistant should enforce the dismissal of communication notifications associated with messages. | 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 | boolean |
| justInTimeSupported | Whether the client supports confirmation flow when a permission is missing. If set to true, the user will be prompted and on confirmation the original flow will continue. | 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 | boolean |
| sleepSensingSupported | Whether the client can monitor sleep. This allows us to show sleep CUJ related information: go/TwilightDesign Use for development only, see the same field in DeviceCapabilities.SoftwareCapabilities.SelinaCapabilities. | 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 | boolean |
| actionV2SupportedFeatures | 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 | AssistantApiActionV2SupportedFeatures | |
| mediaSessionDetection | The ability of the client to detect media sessions on the device. | 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 | String |
| gdiSupported | Whether account linking via Google Deep Integrations (GDI) is supported. go/opa-gdi-design | 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 | boolean |
| zoomSupported | Whether the client supports joining a Zoom meeting. | 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 | boolean |
| persistentDisplaySupported | Whether the client supports persistent display. The new feature allows Assistant devices with screen to display a continuously updating permanent display, such as ambient weather, without the need for a user to ask the Assistant. Design doc: go/assistant-persistent-display. | 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 | boolean |
| alarmTimerManagerApiSupported | Whether the client supports AlarmTimerManager API (go/alarm-timer-manager-api). | 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 | boolean |
| bypassDiDcCheckForComms | Whether communications flows for the client can bypass the DI/DC check. The client will enforce some other equivalent permission as necessary concerning access to device contacts and apps. | 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 | boolean |
| readMessagesTtsTaperingSupported | Whether the client supports tts tapering for the read messages flow. If set to true the tapered tts variant would be used during the read messages flow. | 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 | boolean |
| funtimeSupported | Whether the surface client op performer supports Funtime alarms and timers. go/funtime-engdesign | 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 | boolean |
| webBrowserSupported | Whether the supports opening a URL in a web browser. For example, we want to disable this for clients like Chirp. | 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 | boolean |
| mapsDialogsSupported | Whether the client supports Assistant dialogs within Maps. This field will be set only when the Maps on the surface supports Assistant dialogs embedded within Maps. go/gsa-gmm. | 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 | boolean |
| opaOnSearchSupported | When the entry source is search, whether the client supports rendering a similar response as OPA one does. Entry source is defined at http://cs/symbol:assistant.api.params.DeviceProperties.EntrySource | 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 | boolean |
| isPairedPhoneContactUploadNeededForComms | Whether paired-phone contact upload is needed for communications queries to work (e.g. on AAE). | 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 | boolean |
| noInputResponseSupported | Whether the client can render no input response or just ignore it. No input response is returned when client has a no speech input interaction, eg. user tapped mic but didn’t say anything. | 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 | boolean |
| smartspaceCrossDeviceTimerSupported | Whether the client supports smart space cross-device timers. (go/ss-x-device-timer) | 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 | boolean |
| clientOpResultBatchingSupported | Whether the client can batch client op results before sending them to the server. | 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 | boolean |
| usesSeparateFullViewer | If set, it indicates that the client can open a separate HTML browser/webviewer (full viewer) to display certain visual results. These visual results usually require more memory to render (e.g. high resolution photos). Compared to the regular viewer that display all other Assistant result, the full viewer does not have memory limit. The field is copied from the device model. See http://google3/assistant/devices_platform/proto/device_model_capabilities.proto?l=225&rcl=312576471 Also see go/webassistant-full-card-viewer. | 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 | boolean |
| confirmationBeforeReadingMultipleMessagesSupported | Whether the client supports confirmation flow before announcement of multiple messages. If set to true the user will be prompted once and confirmation will be taken before all the messages are announced. | 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 | boolean |
| messageSummarySupport | The client information for message summary. More details in: go/roadwayrecap-prd | 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 | AssistantApiMessageSummarySupport |
| acpSupport | In what way is assistant continued presence supported. (go/opa-acp-prd) | 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 | AssistantApiAssistantContinuedPresenceSupport |
| viewReminderHubPageNotSupported | Whether the client supports viewing of reminder hub page or not. Default is supported. Set to true to disable returning reminder hub page url in reminder responses. | 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 | boolean |
| duoGroupCallingSupported | Whether the client supports Duo group calling. | 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 | boolean |
| client1mProvidersSupported | Whether the client supports 1m providers (go/1m-partner-expansion). | 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 | boolean |
| hasPhysicalRadio | Whether the client has a physical radio installed. | 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 | boolean |
| liveCardsSupported | Whether the surface supports LiveCards. In cases where the user intent flow cannot be completed within the Assistant, LiveCards are used to take the user to an external app or website. These cards will be pushed to the Google Home app via the PushMessage ClientOp. | 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 | boolean |
| signInMethod | Which kind of sign in the client supports. | 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 | AssistantApiSignInMethod |
| lottieAnimationSupport | Whether the client supports the Lottie animation library for the broadcast feature. | 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 | String |
| serverGeneratedFeedbackChipsEnabled | Whether the Assistant Server should generate feedback suggestion chips. | 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 | boolean |
| transactionFeaturesSupport | Transactions features, supported by the client. Transactions feature may includes how Transactions team want to populate additional information from the device to the server. | 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 | AssistantApiTransactionFeaturesSupport |
| tapToReadOptimizationSupported | Whether the client supports faster optimization for tap_to_read feature. | 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 | boolean |
| remoteCloudCastingEnabled | Whether the client has remote casting enabled. For ex: we want to disable this for clients like Auto. | 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 | boolean |
| crossDeviceBroadcastSupported | Whether the client supports cross-device broadcast (i.e. on Torus). | 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 | boolean |
| suggestionsSupport | Suggestion chips features, supported by the client. | 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 | AssistantApiSuggestionsSupport |
| crossDeviceBroadcastVersion | The version of cross device broadcast (ie; broadcast on torus) which the client supports. | 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 | String |
| conversationalCareSupported | Whether the client can render conversational care responses. go/conversational-care | 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 | boolean |
| assistantForKidsSupported | Whether Assistant for Kids (a.k.a. Designed for Family) features are supported. | 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 | boolean |
| isPairedPhoneNeededForComms | Whether a Bluetooth-paired phone is a core component of communications flows on the client. | 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 | boolean |
| csatVisualOverlaySupported | Whether the client supports csat visual overlay. (go/sd-od-csat) | 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 | boolean |
| transactionsVersion | The version of transactions which the client supports. | 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 | String |
| duoClientApiFeatures | The features set which duo client on the device supports. This should be serialized from proto {@code duo_client_api.DuoClientApiFeatures}. | 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 | String |
| aaeNotificationSourceSupported | Whether the client supports the alternative message notification sources on AAE, in which case notification-related operations can access it. | 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 | boolean |
| immersiveCanvasSupport | 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 | AssistantApiImmersiveCanvasSupport | |
| soliGestureDetectionSupported | Whether or not the client supports gesture detection via soli chips. The reason to prepend the name with soli is to distinguish it from computer vision based methods, e.g. Newman devices. | 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 | boolean |
| lensSupported | Whether the client has Google Lens (Assistant Eyes). | 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 | boolean |
| privacyAwareLockscreenSupported | Whether the client supports the privacy-aware lockscreen protocol (go/assistant-lockscreen-spec). | 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 | boolean |
| assistantExploreSupported | Whether the client supports the assistant explore section. This field will be active only when the Explore section is available to the user. This means that the user is (a) signed-in, (b) a IOPA / AGSA user, and (c) in a locale where explore is available. | 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 | boolean |
| meetSupported | Whether the client supports joining a Google Meet meeting. | 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 | boolean |
| launchKeyboardSupported | Which way of launching the keyboard the client supports. | 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 | String |
| immersiveCanvasConfirmationMessageSupported | Whether the client supports confirmation messages in Immersive Canvas actions. Deprecated: use the filed in immersive_canvas_support. | 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 | boolean |
| warmWelcomeTutorialSupported | Whether the client supports the programmatic warm welcome tutorial. Design doc: go/opal-pww-design. | 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 | boolean |
| inDialogAccountLinkingSupported | Whether the client supports account linking in-dialog (askForSignIn). This is used before this feature is moved to conversation protocol. To support this, the client needs to: – Integrate with Google Deep Integrations. – Have logic to send the result of account linking back to AS. | 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 | boolean |
| thirdPartyGuiSupported | Whether the device supports the 3p GUI framework, which allows third parties to enter the conversation with the user, showing their logo next to their chat bubbles, etc. go/3p-phone | 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 | boolean |
| messageVersion | 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. | list(AssistantApiSupportedProtocolVersionMessageVersionPair) | |
| messageName | The full path of a message which should start from the package name. e.g. “assistant.api.core_types.Timer”. | AssistantApiSupportedProtocolVersionMessageVersionPair | String | |
| version | The supported version number. | AssistantApiSupportedProtocolVersionMessageVersionPair | integer | |
| supportedTypes | AssistantApiSupportedProviderTypes | Types of providers that are supported by the client. For example, ChromeOS support both web app and Android app (for eligible devices). | list(String) | |
| executionCapabilities | AssistantApiSurfaceProperties | Properties of the surface that are not hardware related or feature specific. | AssistantApiSurfacePropertiesExecutionCapabilities | |
| prefersGlanceableUi | Indicates if the surface prefers glanceable UI when rendering Assistant response. (see go/mobile-dr-hbird-glanceable-comms-cuj for more context). | AssistantApiSurfaceProperties | Properties of the surface that are not hardware related or feature specific. | boolean |
| responseDisplayFormat | If this field is unset, the response format is unknown | AssistantApiSurfaceProperties | Properties of the surface that are not hardware related or feature specific. | String |
| supportsMultiResponse | If true, the client supports receiving multiple responses. See go/multiple-response-in-media-use-cases for more details. | AssistantApiSurfaceProperties | Properties of the surface that are not hardware related or feature specific. | boolean |
| supportsClientOpPreloading | Completes the preloading ie., sets up the stage for the execution of client ops on the device while the previous conv delta is being executed. Refer to go/preload-convdelta for more information. | AssistantApiSurfacePropertiesExecutionCapabilities | Describes the capabilities that are related to the execution of client ops on the device. | boolean |
| supportsNonFinalizedResponses | A value of true indicates that the client supports streaming of non-finalized responses by use of ClientExecutionParams.response_stream_id. and ClientExecutionParams.to_be_finalized. | AssistantApiSurfacePropertiesExecutionCapabilities | Describes the capabilities that are related to the execution of client ops on the device. | boolean |
| supportsNonMaterializedInteractions | If true, the client supports receiving non-materialized interactions (go/as-streaming-protocol-nm). | AssistantApiSurfacePropertiesExecutionCapabilities | Describes the capabilities that are related to the execution of client ops on the device. | boolean |
| categoryState | AssistantApiSystemNotificationRestrictions | Restrictions related to system-level notifications. | list(AssistantApiSystemNotificationRestrictionsNotificationCategoryState) | |
| channelState | AssistantApiSystemNotificationRestrictions | Restrictions related to system-level notifications. | list(AssistantApiSystemNotificationRestrictionsNotificationChannelState) | |
| notificationCapabilities | Specifies whether the surface is able to display notifications. | AssistantApiSystemNotificationRestrictions | Restrictions related to system-level notifications. | String |
| categoryId | Notification channel type. | AssistantApiSystemNotificationRestrictionsNotificationCategoryState | Notification channels state for the new server driven channels. | integer |
| disabled | Weather the notifications on this channel are disabled. | AssistantApiSystemNotificationRestrictionsNotificationCategoryState | Notification channels state for the new server driven channels. | boolean |
| disabledReason | AssistantApiSystemNotificationRestrictionsNotificationCategoryState | Notification channels state for the new server driven channels. | String | |
| channelType | Notification channel type. | AssistantApiSystemNotificationRestrictionsNotificationChannelState | Notification channels state. | String |
| enabled | Whether the notifications on this channel are enabled. | AssistantApiSystemNotificationRestrictionsNotificationChannelState | Notification channels state. | boolean |
| deviceActionCapability | DeviceActionCapability from DeviceModelPackage. | AssistantApiThirdPartyActionConfig | 3P Action Metadata. Next ID: 3 | AssistantDevicesPlatformProtoDeviceActionCapability |
| projectConfigs | List of Action project capabilities. | AssistantApiThirdPartyActionConfig | 3P Action Metadata. Next ID: 3 | list(AssistantApiThirdPartyActionConfigProjectConfig) |
| projectId | Google cloud project id for which the Action Package or Device Model is registered. | AssistantApiThirdPartyActionConfigProjectConfig | Metadata for ActionPackage. Device Actions are disabled by default unless explicitly enabled for the device here, see go/3p-device-actions-v2-design. | String |
| dataSharingRestrictions | Restrictions for the device to share any data with third party apps. See details in go/atv-dsc. | AssistantApiThirdPartyCapabilities | String | |
| hour | The hour, in 0…23. | AssistantApiTimeOfDay | A civil time relative to a timezone. | integer |
| minute | The minute, in 0…59. | AssistantApiTimeOfDay | A civil time relative to a timezone. | integer |
| nanosecond | The fraction of seconds in nanoseconds, in 0..999999999. | AssistantApiTimeOfDay | A civil time relative to a timezone. | integer |
| second | The second, in 0…59. Leap seconds are not supported. | AssistantApiTimeOfDay | A civil time relative to a timezone. | integer |
| nanos | Non-negative fractions of a second at nanosecond resolution. | 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. | integer |
| seconds | Seconds of UTC time since the Unix epoch. | 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. | String |
| ianaId | Time zone in IANA format, e.g. America/Los_Angeles for USA Pacific Time. | 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. | String |
| voicePinSuppressed | 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 | AssistantApiTransactionFeaturesSupport | boolean | |
| defaultVolumePercentage | The volume percentages for spelled out values. | AssistantApiVolumeProperties | integer | |
| highVolumePercentage | AssistantApiVolumeProperties | integer | ||
| levelStepSize | The number of levels to move for a step. | AssistantApiVolumeProperties | float | |
| lowVolumePercentage | AssistantApiVolumeProperties | integer | ||
| maximumVolumeLevel | The max number of volume levels the client supports. | AssistantApiVolumeProperties | integer | |
| mediumVolumePercentage | AssistantApiVolumeProperties | integer | ||
| veryHighVolumePercentage | AssistantApiVolumeProperties | integer | ||
| veryLowVolumePercentage | AssistantApiVolumeProperties | integer | ||
| maxSupportedAlarms | Maximum number of alarms that can be created on the client. Zero or unset indicates no maximum limit. | AssistantDevicesPlatformProtoAlarmCapability | Capability with regard to support of alarms by the client. | integer |
| restrictAlarmsToNextDay | Whether the client restricts alarms to ring within the next 24 hours. | AssistantDevicesPlatformProtoAlarmCapability | Capability with regard to support of alarms by the client. | boolean |
| supportsGenericMutations | Whether the client supports mutation of any alarm attribute such as time_pattern, recurrence_pattern, etc through the MUTATE action. If this is false, MUTATE may only be used to disable or dismiss an alarm. This field is true by default for backwards-compatibility; clients which don’t support mutation outside of Disable/DismissAlarm should explicitly set this to false. | AssistantDevicesPlatformProtoAlarmCapability | Capability with regard to support of alarms by the client. | boolean |
| supportsStopAction | Whether the client supports the STOP alarm action. If this is false, stop actions will be represented by the MUTATE action, and the device may need to check alarm state to determine if there’s a firing alarm that needs to be dismissed. | AssistantDevicesPlatformProtoAlarmCapability | Capability with regard to support of alarms by the client. | boolean |
| intValueSpec | AssistantDevicesPlatformProtoArgSpec | AssistantDevicesPlatformProtoIntValueSpec | ||
| optionValueSpec | AssistantDevicesPlatformProtoArgSpec | AssistantDevicesPlatformProtoOptionValueSpec | ||
| type | AssistantDevicesPlatformProtoArgSpec | String | ||
| cloudEndpoints | The list of CloudEndpoints supported by this Device Model. Note that each should have a unique |name|. If any cloud endpoints are provided here, then the first one in the list will be used by default for all Cloud Execution. An Intent may override the default by providing an |execution_config|. | AssistantDevicesPlatformProtoCloudCapability | States the cloud capabilities of the device, i.e. the endpoint(s) to use for cloud execution of Actions or Registration. | list(AssistantDevicesPlatformProtoCloudEndpoint) |
| name | The name for this cloud endpoint. It’s unique per Locale. This is not an API resource name. Ex: sample-nlu-endpoint | AssistantDevicesPlatformProtoCloudEndpoint | A cloud endpoints associates with this device, it can be used for query parsing, or cloud execution. | String |
| scopes | The list of scopes to be provided in the OAuth2 token. They must be a subset of the scopes registered in the Account Linking flow, or the request will fail. If the client itself provides the token, then this field is ignored. | AssistantDevicesPlatformProtoCloudEndpoint | A cloud endpoints associates with this device, it can be used for query parsing, or cloud execution. | list(String) |
| url | The URL for this endpoint, it must start with https. | AssistantDevicesPlatformProtoCloudEndpoint | A cloud endpoints associates with this device, it can be used for query parsing, or cloud execution. | String |
| assistantDeviceInRoomOptOut | Integrate your device with Google’s Smart Home solution by putting your device into Google’s Home Graph, a database that stores and provides contextual data about the home and its devices. For example, Home Graph can store the concept of a living room that contains multiple types of devices, when you say “turn on the light” to a device, if you have light in the living room, that light will be turned on. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | boolean |
| builtInIntentMode | Specifies behavior for built-in device actions for this device model. If not specified, defaults to ENABLE_CONFIGURED_INTENTS_ONLY. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | String |
| customIntentMode | Specifies which custom device actions should be enabled for this device model. This will only affect the behavior of intents corresponding to those from the Action Package of this project. If not specified, defaults to ENABLE_ALL. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | String |
| defaultExecutionConfig | Default instructions for routing of any Intent. The data here could be overridden for specific Intents if provided directly in the ‘intents’ field. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | AssistantDevicesPlatformProtoExecutionConfig |
| inlinedActionCapability | Specifies capabilities for device actions that are inlined in the google.assistant.embedded.v1.DeviceAction message. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | AssistantDevicesPlatformProtoInlinedActionCapability |
| intents | Intent configurations. Built-in and custom intents may be configured here. Note that built-in intents will always behave with IntentMode of ENABLE_CONFIGURED_INTENTS_ONLY. The IntentMode for custom intents can be changed using the custom_intent_mode. To configure an intent, list it here with its intent name, e.g. “MY_CUSTOM_INTENT”, “google.assistant.car.model.capabilities.AC_TEMPERATURE”. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | list(AssistantDevicesPlatformProtoIntent) |
| providedData | 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. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | list(AssistantDevicesPlatformProtoProvidedData) |
| traits | List of built-in traits such as “action.devices.traits.OnOff” See java/com/google/home/graph/service/config/protoconf.pi As of Nov. 2017, we also support custom traits for EAP users. We’ll eventually disable custom traits once custom actions are in place. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | list(String) |
| understandingConfig | Specifies the format how Google routes queries to 3P cloud. By default, this field is unset, all partners should get shallow NLU. This is needed *ONLY* for specific partners for strong business reasons. | AssistantDevicesPlatformProtoDeviceActionCapability | This capability represents device action needed capability. Next ID: 10 | AssistantDevicesPlatformProtoUnderstandingConfig |
| clientOpProperty | AssistantDevicesPlatformProtoDeviceModifySettingCapability | AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty | ||
| cloudEndpointName | Instructions for performing a cloud execution request for the Intent when the execution_type is set to CLOUD. If non-empty, then the device execution would be routed to the CloudEndpoint specified by this name. The Account Linking exchange may be performed to fetch the OAuth access token, and the access token will be included in the HTTP header. | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | String |
| cloudIntentTranslationDisabled | If this field is set, then the Syndication cloud call will be disabled for this intent. Note this only applies if any Syndication cloud endpoint is associated with the Device Model, otherwise setting this field does nothing. By default, all Intents that are enabled and supported by the Syndication API will be routed through the Syndication cloud endpoint if it’s provided. | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | boolean |
| intentCommandFormat | Specifies the intent command format for this Action. For example, in order to launch an Android intent instead of receiving the device action payload on the client, then this field can be set with “intent:/#Intent;…;my_extra={$.params.channels[0].channelCode};end” The parameter “{$.params.channels[0].channelCode}” is in JSON path format, and will be replaced with the content from the original device action payload. Thus, with # JSON “execution”: [ { “command”: “action.devices.commands.SelectChannel”, “params”: { “channels”: [{ “channelName”: “exampleChannel”, “channelCode”: “1-1” }] } } ] as the original action result, then the final result would look like “intent:/#Intent;…;my_extra=\\”1-1\\”;end” | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | String |
| localDisabled | If this field is set, then local execution capability is disabled for all matching intents. | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | boolean |
| localExecutionType | Specifies how to execute this Action when it is invoked locally (from the same device.) | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | String |
| remoteDisabled | If this field is set, then remote execution capability is disabled for all matching intents. | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | boolean |
| remoteExecutionType | Specifies how to execute this Action when it is invoked remotely (from a different device.) | AssistantDevicesPlatformProtoExecutionConfig | Specifies the routing capabilities of the Intent. It will apply only when the Intent is triggered. Next ID: 8 | String |
| alarm | Specifies capabilities for handling on-device alarms. The presence of this field, even if empty, implies that the device supports alarms. | AssistantDevicesPlatformProtoInlinedActionCapability | AssistantDevicesPlatformProtoAlarmCapability | |
| responseLimits | Specifies the size limits on responses. If message is not defined then no limits exist. | AssistantDevicesPlatformProtoInlinedActionCapability | AssistantDevicesPlatformProtoResponseLimits | |
| supportSdkExecute | 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. | AssistantDevicesPlatformProtoInlinedActionCapability | boolean | |
| supportedDeviceOps | Specifies capabilities for handling assistant.embedded.v1.DeviceOp. | AssistantDevicesPlatformProtoInlinedActionCapability | AssistantDevicesPlatformProtoSupportedDeviceOps | |
| supportsMultiResponse | Specifies whether server can send a series of responses for a single query. Example: Routines where multiple actions to be executed one after another. | AssistantDevicesPlatformProtoInlinedActionCapability | boolean | |
| timer | Specifies capabilities for handling on-device timers. The presence of this field, even if empty, implies that the device supports timers. | AssistantDevicesPlatformProtoInlinedActionCapability | AssistantDevicesPlatformProtoTimerCapability | |
| ttsOutput | Specifies whether client supports receiving `DeviceAction.tts_output`. | AssistantDevicesPlatformProtoInlinedActionCapability | AssistantDevicesPlatformProtoTtsOutputCapability | |
| executionConfig | Instructions for the routing of this Intent. | AssistantDevicesPlatformProtoIntent | An intent configures the behavior of a device action for this device. Next ID: 7 | AssistantDevicesPlatformProtoExecutionConfig |
| name | The name of the intent. | AssistantDevicesPlatformProtoIntent | An intent configures the behavior of a device action for this device. Next ID: 7 | String |
| providedDataNames | List of provided data names used by this intent. Note that some built-in intents will not function properly without provided data, such as `action.intent.SwitchChannel` or `action.intent.AppSelector`. | AssistantDevicesPlatformProtoIntent | An intent configures the behavior of a device action for this device. Next ID: 7 | list(String) |
| securityConfig | Security configuration for this Intent. | AssistantDevicesPlatformProtoIntent | An intent configures the behavior of a device action for this device. Next ID: 7 | AssistantDevicesPlatformProtoSecurityConfig |
| triggerConditions | The conditions which must be met by the device before executing this Intent. More than one can be provided, in which case the conditions operate with the “AND” operator, i.e. the first condition which is failed will be used to restrict the execution of this Intent. | AssistantDevicesPlatformProtoIntent | An intent configures the behavior of a device action for this device. Next ID: 7 | list(AssistantDevicesPlatformProtoTriggerCondition) |
| allowedAssistantSdkAuthProjectIds | When using the Assistant SDK (Embedded Assistant API), the project id used to authenticate the gRPC request is checked and must match against the project id of the Device Model. We will additionally allow the project ids listed in the device model here to be let through. See https://docs.google.com/document/d/1InAczpQJs6LCH1l–2yy67JM9hsBJbiL57fusnL3A8A | 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. | list(String) |
| appCapabilitiesFromDeviceInstallApps | Load the assistant.api.AppCapabilities from DEVICE_INSTALLED_APP footprint corpus. See go/edoras-geller. | 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. | boolean |
| cloudDeviceActionEndpoint | Uses this endpoint for device action fulfillment when there’s no endpoint in syndication_metadata. 1p surfaces/devices such as telephone can enable this for its cloud action fulfillment without enabling the whole syndication experience. | 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. | AssistantDevicesPlatformProtoCloudEndpoint |
| deviceActionsEligibleForHighConfidence | Signals that the model will have updated ranking behavior as described in https://docs.google.com/document/d/1SN_AgadRr_cdIrFe-qgRbIX2J1sOE7lcRXAvM1GUPoU. | 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. | boolean |
| forceSignIn | Make Google sign-in mandatory for using Google Assistant on the device. (This bit is initially added for Samsung TV.) | 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. | boolean |
| forceThirdPartyDeviceIdForDeviceLookup | When looking up device (for example for disclosure consent check), then always use the third party device id for lookup instead of any other device id which would normally have higher precedence, such as cast_device_id. | 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. | boolean |
| forceTransactionsAuthentication | Adds “transactions.AUTHENTICATION” for car automation probers. Since the probers run as Assistant SDK requests, voice match always fails for car automation requests, so we add this client op as a hack to allow probers to appear as personal devices and bypass voice match. See b/137221645. | 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. | boolean |
| hasCustomSearchResultsRendering | Signals that this device can “render” raw search results even with no screen (e.g., using a text reader). If this is true, fallback search results can be returned as a custom device action in a SearchResults message. http://google3/assistant/embedded/proto_translation/utils/proto/search_results.proto | 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. | boolean |
| overrideProjectIdForDeviceLookup | When looking up device (for example for disclosure consent check), use this project id as part of the primary key for the device lookup (i.e. instead of the device_config.agent_id.) The precedence is as follows: 1) this field, if set for the device’s device model 2) device_config.agent_id 3) device_model.project_id | 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. | String |
| stadiaAssistantConfig | 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. | AssistantDevicesPlatformProtoInternalCapabilityStadiaAssistantConfig | |
| telephoneAttribution | Telephone server is able to send attribution to user feature phone. See go/telephone-attribution. | 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. | boolean |
| stadiaPlatform | AssistantDevicesPlatformProtoInternalCapabilityStadiaAssistantConfig | The StadiaAssistantConfig. This field should only be set if the device model is a Stadia. | String | |
| maxValue | AssistantDevicesPlatformProtoIntValueSpec | String | ||
| minValue | AssistantDevicesPlatformProtoIntValueSpec | String | ||
| values | AssistantDevicesPlatformProtoOptionValueSpec | list(String) | ||
| name | 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. | String | |
| clientOpProperty | AssistantDevicesPlatformProtoProviderOpenCapability | AssistantApiClientOpPropertiesProviderOpenClientOpProperty | ||
| maxAssistResponseSizeBytes | Max size in bytes of the total serialized AssistResponse receivable by the client. If response exceeds this max, response may be modified by the server. | AssistantDevicesPlatformProtoResponseLimits | Specifies the size limits on responses receivable by the client. | integer |
| maxDisplayLinesBytes | Maximum size in bytes (not characters) of text the display can handle (which may be different from how much the display can show at a time due to scrolling). | AssistantDevicesPlatformProtoResponseLimits | Specifies the size limits on responses receivable by the client. | integer |
| maxSuggestionChipBytes | Maximum size in bytes (not characters) for each suggestion chip. | AssistantDevicesPlatformProtoResponseLimits | Specifies the size limits on responses receivable by the client. | integer |
| maxSuggestionChips | Maximum number of suggestion chips the device can handle to display. | AssistantDevicesPlatformProtoResponseLimits | Specifies the size limits on responses receivable by the client. | integer |
| authMechanismForRemoteRequests | Specifies auth mechanism to be used upon remote request for device action. | AssistantDevicesPlatformProtoSecurityConfig | Encapsulates security configuration for a single intent of a device model. | String |
| callCall | |call_call| specifies the support for the call.CALL clientop, and the corresponding call_call field in assistant.embedded.v1.DeviceOp. | 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 | AssistantDevicesPlatformProtoCallCallCapability |
| clientReconnect | |client_reconnect| indicates support for client.RECONNECT using assistant.embedded.v1.DeviceOp. There is an alternative API/capability for client.RECONNECT specified in RoutineCapability.supports_reconnect. Client should choose between this and RoutineCapability but not both. | 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 | AssistantDevicesPlatformProtoClientReconnectCapability |
| coreDismissAssistant | [core_dismiss_assistant] specifies the support for core.DISMISS_ASSISTANT client_op and the corresponding core_dismiss_assistant field in assistant.embedded.v1.DeviceOp. | 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 | AssistantDevicesPlatformProtoCoreDismissAssistantCapability |
| deviceModifySetting | |device_modify_setting| specifies the support for device.MODIFY_SETTING client_op, and the corresponding device_modify_setting field in assistant.embedded.v1.DeviceOp. | 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 | AssistantDevicesPlatformProtoDeviceModifySettingCapability |
| deviceTakePhoto | [device_take_photo] specifies the support for the device.TAKE_PHOTO clientop, and the corresponding device_take_photo field in assistant.embedded.v1.DeviceOp. | 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 | AssistantDevicesPlatformProtoDeviceTakePhotoCapability |
| executionWait | |execution_wait| specifies the support for execution.WAIT client_op, and the corresponding execution_wait field in assistant.embedded.v1.DeviceOp. | 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 | AssistantDevicesPlatformProtoExecutionWaitCapability |
| getHealthObservation | |get_health_observation| specifies the support for get_health_observation client_op, and the corresponding get_health_observation field in assistant.embedded.v1.DeviceOp. | 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 | AssistantDevicesPlatformProtoGetHealthObservationCapability |
| mediaNext | 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 | AssistantDevicesPlatformProtoMediaNextCapability | |
| mediaPause | 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 | AssistantDevicesPlatformProtoMediaPauseCapability | |
| mediaPlayMedia | 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 | AssistantDevicesPlatformProtoMediaPlayMediaCapability | |
| mediaPrevious | 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 | AssistantDevicesPlatformProtoMediaPreviousCapability | |
| mediaResume | 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 | AssistantDevicesPlatformProtoMediaResumeCapability | |
| mediaShowControls | 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 | AssistantDevicesPlatformProtoMediaShowControlsCapability | |
| mediaStop | 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 | AssistantDevicesPlatformProtoMediaStopCapability | |
| providerFulfill | |provider_fulfill| specifies the support for provider.FULFILL client_op, and the corresponding provider_fulfill field in assistant.embedded.v1.DeviceOp. | 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 | AssistantDevicesPlatformProtoProviderFulfillCapability |
| providerOpen | |provider_open| specifies the support for provider.OPEN client_op, and the corresponding provider_open field in assistant.embedded.v1.DeviceOp. | 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 | AssistantDevicesPlatformProtoProviderOpenCapability |
| sendChatMessage | |send_chat_message| specifies the support for the chat_message.SEND clientop, and the corresponding send_chat_message field in assistant.embedded.v1.DeviceOp. | 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 | AssistantDevicesPlatformProtoSendChatMessageCapability |
| uiShowInterpreter | |ui_show_interpreter| specifies the support for ui.SHOW_INTERPRETER client_op, and the corresponding ui_show_interpreter field in assistant.embedded.v1.DeviceOp. | 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 | AssistantDevicesPlatformProtoUiShowInterpreterCapability |
| maxSupportedExtendedTimerDuration | Maximum extended timer duration supported by the client. The extended timer duration is the total start-to-finish duration after an AddTimeToTimer operation. E.g. if a user sets a timer for 30 minutes, and later adds 10 minutes, the extended duration is 40 minutes. Zero or unset indicates no maximum limit. | AssistantDevicesPlatformProtoTimerCapability | Capability with regard to support of timers by the client. | AssistantApiDuration |
| maxSupportedTimerDuration | Maximum timer duration supported by the client. Zero or unset indicates no maximum limit. | AssistantDevicesPlatformProtoTimerCapability | Capability with regard to support of timers by the client. | AssistantApiDuration |
| maxSupportedTimers | Maximum number of timers that can be created on the client. Zero or unset indicates no maximum limit. | AssistantDevicesPlatformProtoTimerCapability | Capability with regard to support of timers by the client. | integer |
| supportsMutateAction | Whether the client supports the MUTATE timer action. If this is false, mutate operations may be handled by sending a pair of REMOVE and CREATE timer actions to replace the existing timer instead of mutating it. | AssistantDevicesPlatformProtoTimerCapability | Capability with regard to support of timers by the client. | boolean |
| simpleTts | A simple TTS to play. | 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. | String |
| status | Refers to a defined ConditionalResult keyed by its status. It could be a built-in or custom ConditionalResult for this Intent. Note: the states provided by the device MUST contain all of the states required by the ConditionalResult. | 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. | String |
| supportsStructuredTts | Specifies whether client supports out-of-band TTS synthesis. When this is enabled, client could receive TTS request message in `SpeechOutputArgs.structured_tts` which it can then use to make request to S3 for synthesizing TTS audio. | AssistantDevicesPlatformProtoTtsOutputCapability | Capabilities with regard to support of outputting TTS. | boolean |
| nluLevel | Specifies the NLU level for the intent. | AssistantDevicesPlatformProtoUnderstandingConfig | Specifies the NLU level that Google performs, which determines the request format sent to the 3P cloud. | String |
| type | AssistantDeviceTargetingDeviceTargetingError | The information associated with an error while selecting the target device. Next ID: 2 | String | |
| streams | All active media streams while the user issues the query. | AssistantLogsAllMediaStreamLog | list(AssistantLogsMediaStreamLog) | |
| targetStream | 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. | AssistantLogsAllMediaStreamLog | AssistantLogsMediaStreamLog | |
| ambiguousDeviceIndex | Device index of the initial ambiguous devices. The device index in this message is consistent with the device index in DeviceInfoLog. It would be used to track more detailed information of a device if needed. | 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. | list(integer) |
| devicesAfterPromoters | DeviceInfo for devices after the filters and promoters. – When device targeting is only configured for single target, these are ambiguous devices that would have been the output of Lumos. Downstream may perform extra check before disambiguation dialog. For example, Media Initiation checks playability for devices. The output here is before the check. – When configured for multi-target, these are just the target devices. For privacy consideration, we may only log device id field inside. | 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. | list(AssistantLogsDeviceInfoLog) |
| finalTargetDevice | the final targeted device selected by playability filter or DeviceSelectionDialog | 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. | AssistantLogsDeviceInfoLog |
| playabilityFilteredDevicesIndex | Device index of the devices after playability filter | 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. | list(integer) |
| puntInfoLog | When there is no qualified devices after playability check, it would populate punt_info below. If all devices are filtered out for the same reason, there would only be one item. Otherwise, there will be multiple items. | 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. | list(AssistantLogsAmbiguousTargetDeviceLogPuntInfoLog) |
| structureFilteredDeviceIndex | Device index of the devices after structure filter | 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. | list(integer) |
| deviceIndex | Index of devices that have the same punt info during playability check, i.e. same media_excuse and provider_mid. | 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. | list(integer) |
| mediaExcuse | Excuse for media action triggering. See: assistant/verticals/media/proto/media_excuse.proto. | 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. | integer |
| providerMid | Provider id that the excuse belongs to. This is the KG MID of the provider, e.g., “/m/09jcvs” for Youtube. | 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. | String |
| localNetworkIdDiff | The diff between AvailableDevice and CTF for the local network ID of the device. | AssistantLogsAvailableDeviceAndCtfContextDiffLog | A list of per-device contexts and their respective diffs between AvailableDevice and CTF. | String |
| locationFeatureDiff | The diff between AvailableDevice and CTF for the feature proto of the location of the device. | AssistantLogsAvailableDeviceAndCtfContextDiffLog | A list of per-device contexts and their respective diffs between AvailableDevice and CTF. | String |
| availableDeviceInfoLog | AssistantLogsAvailableDevicesLog | Contains the available devices in DeviceTargetingContext. | list(AssistantLogsDeviceInfoLog) | |
| rawContactInfo | This list provides account information from the raw contact which is the source of this field. | AssistantLogsCommunicationDeviceContactInfoLog | This is the log version of apps.people.oz.external.mergedpeopleapi.DeviceContactInfo Next ID: 2 | list(AssistantLogsCommunicationRawDeviceContactInfoLog) |
| relativeCost | AssistantLogsCommunicationFuzzyNgramMatchLog | This is the log version of fuzzy ngram match results that’s used for generating the best fuzzy match. Next ID: 3 | number | |
| type | AssistantLogsCommunicationFuzzyNgramMatchLog | This is the log version of fuzzy ngram match results that’s used for generating the best fuzzy match. Next ID: 3 | String | |
| 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 | String | ||
| gaiaId | 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 | String | |
| isDasherAccount | 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 | boolean | |
| accountProvenance | Google AccountProvenance of the contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | AssistantLogsCommunicationGoogleAccountProvenance |
| commonNameAliasConfidence | Populated if matched_name_type is GIVEN_NAME_ALIAS or FULL_NAME_ALIAS. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | number |
| conceptId | Concept id for relationships in English, e.g. “Mother” for all non-English locales. It’s only populated for source = RELATIONSHIP. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| deviceContactAttributes | Integer value corresponding to DeviceContactExtraMetadata.Attribute enum. http://google3/social/graph/wire/proto/merged_person.proto?l=933&rcl=320308954 | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(integer) |
| emailIdCount | # emails stored for the contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | integer |
| fuzzyNgramMatch | Populate only if ContactRecognitionAlternate.Source is ‘FUZZY_CONTACT_MATCH’. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(AssistantLogsCommunicationFuzzyNgramMatchLog) |
| gaiaId | Contact owner’s gaia id from cs/symbol::symbol:quality_qrewrite.PersonalContactData.shared_contact_owner_gaia_id. Only populated for is_shared = true and non sign-out mode and user is not the owner of the contact(shared contact from other user). This field is not being logged in P2. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| isContactFromSecondaryAccount | Boolean value indicating whether selected contact is from different account than the logged in account. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| isExactMatch | If the contact is matched exactly from the query name. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| isShared | If this is a shared contact. This is true in 2 cases: – User is calling their own contacts that have been marked as shared. – User is calling shared contacts from some other user’s contact list. This field is not being logged in P2. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| isTransliteratedMatch | Indicate the contact matches the transliterated query. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| isVanityContact | True if the contact is a vanity contact(has email = user’s email address). | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| isVisibleToGuestsRelationship | If the lookup was done using relationship which is visible to guests. This value will only be set if lookup was done using relationship. E.g. user has a guest relationship (doctor) -> (John) And user says “call doctor”, then this value will be true. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | boolean |
| matchedNameType | The matched name type of a contact candidate. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| matchedRecognitionAlternateName | Alternate recognition term which was used to match this contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| matchedStarlightLookupName | Ngram matched by starlight lookup for fuzzy matching in fulfillment. We need this to analyze how many contacts are returned by starlight lookup that is not matched by fuzzy matching. For example, “Komal Dear” is matched to “Komal Dr” by fuzzy match. When doing starlight lookup, “Komal” and “Dr” will be looked up separately. So “Dr xxx” will also be returned. We want to see how often this happens. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(String) |
| metadata | PersonMetadata of the selected contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | AssistantLogsCommunicationPersonMetadataLog |
| nameMatchedContactIndex | The indices of the contact in |candidate_contact| whose name matches the |selected_contact_data|. |candidate_contact|: http://google3/logs/proto/assistant/contact.proto?l=111&rcl=306283376 |selected_contact_data|: http://google3/logs/proto/assistant/contact.proto?l=108&rcl=306283376 | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(integer) |
| originalQueryName | The original name in the query as transcribed by ASR. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| phone | Information regarding the phone endpoints of the selected contact. Currently it is only logged for selected candidate. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(AssistantLogsCommunicationPhoneLog) |
| phoneNumberCount | # phone_numbers stored for the contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | integer |
| pkgReferenceType | Encodes if pkg_person was resolved via a name or relationship reference. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| recognitionAlternateScore | Populate only if ContactRecognitionAlternate.Source is not NONE. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | number |
| recognitionAlternateSource | Recognition alternative source type. If not none, then it indicates the personal contact data is alternative and how the alternative is fulfilled. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| relationshipMemoryCount | The number of resolved relationship names and contact pointers from Assistant Memory. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | integer |
| selectedPhone | Information regarding the selected phone endpoint. Currently it is only logged for selected candidate. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | AssistantLogsCommunicationPhoneLog |
| shortcutContactInfo | Shortcut information of the contact. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | MajelContactInformationShortcutInformation |
| source | The contact source of a contact candidate. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | String |
| systemContactGroupId | Integer value corresponding to SystemContactGroup enum. http://google3/social/graph/wire/proto/merged_person.proto?l=3151&rcl=320308954 | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | list(integer) |
| whatsappPhoneNumberCount | DEPRECATED. Use phone instead. Used before 2020-01-13. Number of phone numbers annotated with Whatsapp. | AssistantLogsCommunicationPersonalContactDataLog | Contact meta data. Next ID: 31 | integer |
| deviceContactInfo | AssistantLogsCommunicationPersonMetadataLog | This is the log version of apps.people.oz.external.mergedpeopleapi.PersonMetadata Next ID: 2 | list(AssistantLogsCommunicationDeviceContactInfoLog) | |
| rawDeviceContactInfo | This list provides account information from the raw contact which is the source of this field. | AssistantLogsCommunicationPhoneLog | This is the log version of apps.people.oz.external.mergedpeopleapi.Phone proto. Next ID: 3 | list(AssistantLogsCommunicationRawDeviceContactInfoLog) |
| type | Label for phone number in the Contacts app. It can have standard values provided by the app e.g. MOBILE, HOME, WORK etc, but users are allowed to modify. So essentially it becomes user content. | AssistantLogsCommunicationPhoneLog | This is the log version of apps.people.oz.external.mergedpeopleapi.Phone proto. Next ID: 3 | String |
| accountType | Account type of raw contact, e.g. “com.google” or “com.linkedin.android”. | AssistantLogsCommunicationRawDeviceContactInfoLog | This is the log version of apps.people.oz.external.mergedpeopleapi.RawDeviceContactInfo proto. Next ID: 3 | String |
| defaultSpeaker | AssistantLogsDefaultDeviceLog | Log device info of default speaker and tv | AssistantLogsDeviceInfoLog | |
| defaultTv | AssistantLogsDefaultDeviceLog | Log device info of default speaker and tv | AssistantLogsDeviceInfoLog | |
| sourceDeviceId | AssistantLogsDefaultDeviceLog | Log device info of default speaker and tv | String | |
| localDefaultDevices | AssistantLogsDefaultDevicesLog | AssistantLogsDefaultDeviceLog | ||
| nearbyDefaultDevices | Default settings of nearby devices. | AssistantLogsDefaultDevicesLog | list(AssistantLogsDefaultDeviceLog) | |
| deviceIdLog | The identification of the device. The logging version of the full DeviceId. | AssistantLogsDeviceAnnotationLog | Device annotation mention from query | list(AssistantLogsSettingsDeviceIdLog) |
| rawTextFromQuery | The raw text mentioning a device from the query, such as “any tv”. | AssistantLogsDeviceAnnotationLog | Device annotation mention from query | String |
| type | The annotation type mentioned in the query. | AssistantLogsDeviceAnnotationLog | Device annotation mention from query | String |
| userDefinedName | The matched device name set by the user, such as “big screen tv”. | AssistantLogsDeviceAnnotationLog | Device annotation mention from query | String |
| arbitrationDeviceId | Device identifier string for the current device used in the arbitration service. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| availableDeviceAndCtfContextDiff | A list of diffs for the device’s context between AvailableDevice and CTF. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | AssistantLogsAvailableDeviceAndCtfContextDiffLog |
| connectivity | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String | |
| deviceId | The identification of the device. DeviceId (go/as-device-id) has multiple fields. To consloidate it to a single to make dremel easier, we use the string obtained by calling go/get-device-id. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| deviceIdLog | The identification of the device. The logging version of the full DeviceId. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | AssistantLogsSettingsDeviceIdLog |
| deviceIndex | We index linked devices and log these index to avoid logging device_id. device_index should always be a positive number or -1. -1 means this device is not in homegraph. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | integer |
| deviceModelId | This is the device_model_id field in device_settings proto. It has the same value for the same type of devices. e.g. Sonos.Sonos One.S13 | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| distance | LINT.ThenChange(//depot/google3/assistant/context/proto/device_arbitration.proto:EstimatedRelativeDistance) | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| eliminatingLumosProcessor | The lumos processor which eliminated this device, if applicable | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| homeStructureId | The home structure id of the device. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| isRemote | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | boolean | |
| isTethered | This flag indicates this is a non-local device that is tethered to local/originating device. Tethered device is a special case of is_remote and typically used in wearable scenarios. This is always false for local device and when it is true, it implies is_remote is also true. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | boolean |
| mediaCapabilities | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | AssistantLogsMediaCapabilities | |
| mediaDeviceType | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String | |
| name | User defined device name | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| sessions | This field should be populated only when there is at least one session on this device. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | list(AssistantLogsDeviceMediaSessionLog) |
| surfaceType | This field should be populated only when the device is an Assistant device. | AssistantLogsDeviceInfoLog | The information related to the device. Next ID: 19 | String |
| deviceId | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | AssistantApiCoreTypesDeviceId | |
| mediaSessionType | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | String | |
| mediaType | The type of the media session. If provider does not report this field, we ## compute it by mapping provider type to media type. Here is the mapping: |ProviderType |MediaItemMetadata.Type| |————————————– |MUSIC |TRACK | |VIDEO |VIDEO | |LIVE_TV |TV_CHANNEL | |AUDIOBOOK |AUDIO_BOOK | |PODCAST |PODCAST_EPISODE | ## |LIVE_STREAMING|VIDEO | | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | String |
| playbackState | The playback states of the session. | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | String |
| providerMid | The KG mid of the media provider. | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | String |
| supportedTransportControl | AssistantLogsDeviceMediaSessionLog | Log about the media session on a device. | list(String) | |
| allDefaultDevices | Default settings of all nearby devices Deprecated, use default_devices_log instead. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | list(AssistantLogsDefaultDeviceLog) |
| allMediaStreamLog | Logs all active media sessions. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsAllMediaStreamLog |
| availableDevicesLog | The list of `available_devices` as they appear in DeviceTargetingContext. This is very useful for debugging diffs between GB and CMP since they have different methods of populating the `available_devices` field. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsAvailableDevicesLog |
| counterfactualDeviceSelectionLog | DeviceSelectionLog for counterfactual logging. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsDeviceSelectionLog |
| defaultDevices | Include default tv and default speaker Deprecated, use all_default_devices below. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsDefaultDeviceLog |
| defaultDevicesLog | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsDefaultDevicesLog | |
| devicesStr | Temporaray field for debugging ANDROID_AUTO multi_target_devices punt. This will be removed once we identify the root cause. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | list(String) |
| inputErrorLog | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | list(AssistantLogsInputErrorLog) | |
| localDevice | Now we just log the media sessions on local device Deprecated, use NearbyDevicesLog::LocalDevice instead. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsDeviceInfoLog |
| logDataSource | Indicates which library populated the device_selection_log for this query. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | String |
| mediaFocus | The Media Focus information. This field should be populated only when there is a Media Focus. Deprecated, use media_focuses below instead. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsMediaFocusInfoLog |
| mediaFocusesLog | Media focuses on all devices. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsMediaFocusesLog |
| nearbyDevicesLog | All nearby devices and local device. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsNearbyDevicesLog |
| queryAnnotation | This should log the query annotation features found in the device, such as the device annotation, the room annotation, and the structure annotation from the query. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsQueryAnnotationLog |
| selectionResult | The result of device selection. | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | AssistantLogsDeviceSelectionResultLog |
| testCodes | AssistantLogsDeviceSelectionLog | Contains information logged in target device selection. See go/improve-device-targeting-logging for details. Next Id: 23 | list(AssistantLogsDeviceTargetingTestCode) | |
| ambiguousTargetDevices | Deprecated, please use qualified_devices. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsAmbiguousTargetDeviceLog |
| deviceSelectionDecisionSummary | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsMediaDeviceSelectionDecisionSummary | |
| deviceTargetingErrorType | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | String | |
| finalLumosStage | The class name for the final filter/promoter used by Lumos for device targeting. This filter or promoter runs for all users, and contains no data specific to the individual user. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | String |
| lowConfidenceTargetDevice | ////////////////////////////////////////////////////////////////////////// Ambiguous Results: the library failed to select the final target device(s) but it narrows down to a set of devices which are all valid target device candidates. The client needs to do further disambiguation, e.g., giving a dialog or having customized logic. The low confidence target device means the library falied to select the target device but it picked two devices for the client to do disambiguation. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsLowConfidenceTargetDeviceLog |
| mediaFocusSelectionErrorType | ////////////////////////////////////////////////////////////////////////// This field log the error while selecting target device in media_focus_selector. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | String |
| processorInfo | The log for each stage of Lumos, showing the number of eliminated devices from each processor. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | list(AssistantLogsLumosProcessorInfo) |
| qualifiedDevices | We will apply several filters and dialogs to select a target device if media_focus_selector fail to select one. This field should log the devices left after each filter or dialog. It also log the detailed info of the final target device. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsAmbiguousTargetDeviceLog |
| singleTargetDevice | ////////////////////////////////////////////////////////////////////////// Unambiguous Results: the library successfully selected the final target device(s) and no further disambiguation is needed. Deprecated, please use target_device. | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsDeviceInfoLog |
| targetDevice | AssistantLogsDeviceSelectionResultLog | Log the selection result. Next ID: 11 | AssistantLogsTargetDeviceLog | |
| type | AssistantLogsDeviceTargetingTestCode | Test code is used to track special events happening in Device Targeting Library. Next Id: 2 | String | |
| errorCode | AssistantLogsInputErrorLog | integer | ||
| errorType | AssistantLogsInputErrorLog | String | ||
| fallbackDeviceLog | The fallback device. | 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 | AssistantLogsDeviceInfoLog |
| lowConfTargetDeviceLog | The selected low confidence focus device. | 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 | AssistantLogsDeviceInfoLog |
| devicesAfterRun | Number of candidate devices after this stage is run. | AssistantLogsLumosProcessorInfo | integer | |
| devicesBeforeRun | Number of candidate devices before this stage is run. | AssistantLogsLumosProcessorInfo | integer | |
| processorName | Name of the processor for this stage. | AssistantLogsLumosProcessorInfo | String | |
| canReceiveRemoteAction | AssistantLogsMediaCapabilities | boolean | ||
| hasScreen | AssistantLogsMediaCapabilities | boolean | ||
| deviceSelectionPreferenceUsed | AssistantLogsMediaDeviceSelectionDecisionSummary | A summary of the reasons that we chose a certain target device. | String | |
| deviceSelectionReason | AssistantLogsMediaDeviceSelectionDecisionSummary | A summary of the reasons that we chose a certain target device. | String | |
| miscSelectionSignal | AssistantLogsMediaDeviceSelectionDecisionSummary | A summary of the reasons that we chose a certain target device. | list(String) | |
| dialogTriggered | AssistantLogsMediaFocusesLog | Following are the MDA compatible loggings for media focus, default settings and nearby devices. | boolean | |
| localMediaFocus | AssistantLogsMediaFocusesLog | Following are the MDA compatible loggings for media focus, default settings and nearby devices. | AssistantLogsMediaFocusInfoLog | |
| mediaFocuses | Deprecated, use nearby_media_focuses instead. | AssistantLogsMediaFocusesLog | Following are the MDA compatible loggings for media focus, default settings and nearby devices. | list(AssistantLogsMediaFocusInfoLog) |
| nearbyMediaFocuses | MediaFouces found on nearby devices. | AssistantLogsMediaFocusesLog | Following are the MDA compatible loggings for media focus, default settings and nearby devices. | list(AssistantLogsMediaFocusInfoLog) |
| currentFocusDurationSec | How long the device is in focus so far | 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 | integer |
| dialogTriggered | TODO(b/134944092) Log MediaFocusDialogTrigger Enum in focus_status. | 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 | boolean |
| focusDevice | LINT.ThenChange(//depot/google3/logs/proto/majel_gws/media_action_triggering_info.proto) The focus device. | 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 | AssistantLogsDeviceInfoLog |
| mediaFocusState | The media focus state at the time of the request. | 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 | String |
| sourceDeviceId | The source device of media focus. | 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 | String |
| deviceIndex | The device index in this message is consistent with the device index in DeviceInfoLog. This field refers to the devices that hosting the session. | 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. | list(integer) |
| session | 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. | AssistantLogsDeviceMediaSessionLog | |
| deviceArbitrationCreationTimestampMs | The timestamp that DeviceArbitration is created in milliseconds. | AssistantLogsNearbyDevicesLog | String | |
| deviceTargetingInputCreationTimestampMs | The timestamp that DeviceTargetingInput is built in milliseconds. | AssistantLogsNearbyDevicesLog | String | |
| eliminatedByFurtherDistance | AssistantLogsNearbyDevicesLog | integer | ||
| eliminatedByLocalClosest | AssistantLogsNearbyDevicesLog | integer | ||
| eliminatedByUnknownDifferentRoom | AssistantLogsNearbyDevicesLog | integer | ||
| eliminatedByUnregisteredDevice | AssistantLogsNearbyDevicesLog | integer | ||
| localDevice | AssistantLogsNearbyDevicesLog | AssistantLogsDeviceInfoLog | ||
| nearbyDevices | AssistantLogsNearbyDevicesLog | list(AssistantLogsDeviceInfoLog) | ||
| numClosestDevices | AssistantLogsNearbyDevicesLog | integer | ||
| numEquallyCloseDevices | AssistantLogsNearbyDevicesLog | integer | ||
| numFurtherDevices | AssistantLogsNearbyDevicesLog | integer | ||
| numHearingDevices | AssistantLogsNearbyDevicesLog | integer | ||
| numUnknownDistanceDevices | AssistantLogsNearbyDevicesLog | integer | ||
| lang | 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.) | String | |
| localizedNames | 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.) | list(String) | |
| packageNames | 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.) | list(String) | |
| deviceAnnotation | Deprecated, please use room_annotations. | AssistantLogsQueryAnnotationLog | Log about the query requirements | AssistantLogsDeviceAnnotationLog |
| deviceAnnotations | Log the device annotations mentioned in the query. | AssistantLogsQueryAnnotationLog | Log about the query requirements | list(AssistantLogsDeviceAnnotationLog) |
| providerAnnotation | Log the provider annotations annotated from the query. | AssistantLogsQueryAnnotationLog | Log about the query requirements | AssistantLogsProviderAnnotationLog |
| roomAnnotation | TODO(b/171250187) Deprecates the optional RoomAnnotationLog and DeviceAnnotationLog. Deprecated, please use device_annotations. | AssistantLogsQueryAnnotationLog | Log about the query requirements | AssistantLogsRoomAnnotationLog |
| roomAnnotations | Log the room annotations mentioned in the query. | AssistantLogsQueryAnnotationLog | Log about the query requirements | list(AssistantLogsRoomAnnotationLog) |
| structureAnnotations | Log the structure annotations mentioned in the query. | AssistantLogsQueryAnnotationLog | Log about the query requirements | list(AssistantLogsStructureAnnotationLog) |
| createdSecondsAgo | The reminder is created N seconds ago. This helps tracking how the user issues follow-up actions after reminder is created. For example, whether the user likes to issues another [show reminders] query right after reminder is created? | AssistantLogsReminderLog | Annotate a single reminder instance. | String |
| retrievedRankingClass | If the reminder is retrieved by a ranking class (see go/opa-reminders-ranker), this will be populated with the class info. Refer to assistant.productivity.ReminderRankingClass.RankingType. Since that proto is in proto2 format, we can only wire by int type. | AssistantLogsReminderLog | Annotate a single reminder instance. | integer |
| rawTextFromQuery | The raw text mentioning a room from the query, such as “my living room”. | AssistantLogsRoomAnnotationLog | Room annotation mentioned in query. | String |
| roomCount | The number of rooms annotated, if there are multiple structures. They are guaranteed to have the same text_from_query and name due to exact matching. | AssistantLogsRoomAnnotationLog | Room annotation mentioned in query. | integer |
| roomId | The identification of the room. | AssistantLogsRoomAnnotationLog | Room annotation mentioned in query. | list(String) |
| type | The annotation type mentioned in the query. | AssistantLogsRoomAnnotationLog | Room annotation mentioned in query. | String |
| userDefinedName | AssistantLogsRoomAnnotationLog | Room annotation mentioned in query. | String | |
| agsaClientInstanceId | The client_instance_id on devices with GSA. See ‘client_instance_field’ in go/androidids. | 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 | String |
| alloDeviceId | Allo Id. Corresponds to the GBotRequest.Sender.sender. This ID type should be deprecated by now, yet we’ve observed it serving prod traffic in GB. | 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 | String |
| canonicalDeviceId | A unique device ID for Assistant devices as proposed by go/ocelot-team. | 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 | String |
| castDeviceId | If set, indicates that the device is a cast device, and contains the UUID of the cast device. Corresponds to the device_id field of the CastDevice proto. | 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 | String |
| clientInstanceId | DUSI (go/dusi) is used as the identifier here. This identifier is unique to the user and device. This will help identify which device or application the user’s request originated from. This is not to be confused with the client_instance_id that android devices provide. This is currently used by surfaces that use the assistant-legacy-nexus and assistant-legacy-clockwork pipelines. DUSI is created and set in S3. This field is only filled for GAIA requests. | 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 | String |
| deviceConfigId | The unique DeviceConfig to the specific third party device. It is also used by Android Auto Embedded first party device. See go/opa-ids. | 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 | String |
| homeGraphDeviceId | The unique device ID for HomeGraph devices. This is the HomeGraph ID, created when the device is registered into HomeGraph. It is immutable for the same device unless it is completely deleted and recreated. See go/home-graph for details. } | 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 | String |
| libassistantDeviceId | The unique ID for libassistant based devices. | 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 | String |
| opaIosDeviceId | The unique device ID for the Assistant App on iOS. See go/opa-ios-design for details. | 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 | String |
| rawTextFromQuery | The raw text mentioning a structure from the query, such as “my house”. | AssistantLogsStructureAnnotationLog | Structure annotation mentioned in query. | String |
| structureId | The identification of the structure. | AssistantLogsStructureAnnotationLog | Structure annotation mentioned in query. | list(String) |
| type | The annotation type mentioned in the query. | AssistantLogsStructureAnnotationLog | Structure annotation mentioned in query. | String |
| userDefinedName | AssistantLogsStructureAnnotationLog | Structure annotation mentioned in query. | String | |
| devices | AssistantLogsTargetDeviceLog | Represents the case where the library successfully selects the target device. It could be one or multiple devices. Next ID: 4 | list(AssistantLogsDeviceInfoLog) | |
| lowConfidenceReason | AssistantLogsTargetDeviceLog | Represents the case where the library successfully selects the target device. It could be one or multiple devices. Next ID: 4 | String | |
| resultConfidenceLevel | AssistantLogsTargetDeviceLog | Represents the case where the library successfully selects the target device. It could be one or multiple devices. Next ID: 4 | String | |
| deviceName | AssistantPfrDeviceRdMetadata | String | ||
| deviceTypes | AssistantPfrDeviceRdMetadata | list(String) | ||
| effectiveArgSpanLength | AssistantPfrDeviceRdMetadata | number | ||
| hasAmbiguousResolutions | True if there are more than one possible resolutions to the RD. | AssistantPfrDeviceRdMetadata | boolean | |
| hasResolvedDeviceId | 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. | AssistantPfrDeviceRdMetadata | boolean | |
| roomName | AssistantPfrDeviceRdMetadata | String | ||
| deviceRdMetadata | Each DeviceRdMetadata represents one device RD (device slot) in the intent. Note that each device RD could have multiple device groundings inside of it. | AssistantPfrSmartHomeIntentMetadata | Used by the Smarthome Business Rules twiddler to determine whether to replace the top-scoring Smarthome intent with another. | list(AssistantPfrDeviceRdMetadata) |
| intentName | AssistantPfrSmartHomeIntentMetadata | Used by the Smarthome Business Rules twiddler to determine whether to replace the top-scoring Smarthome intent with another. | String | |
| isExactMatch | When num_constraints == num_constraints_satisfied, indicating all slot matchings are exact match. | AssistantPfrSmartHomeIntentMetadata | Used by the Smarthome Business Rules twiddler to determine whether to replace the top-scoring Smarthome intent with another. | boolean |
| isGrounded | When num_grounded_args > 0, indicating there is at least one top-level argument is grounded. | AssistantPfrSmartHomeIntentMetadata | Used by the Smarthome Business Rules twiddler to determine whether to replace the top-scoring Smarthome intent with another. | boolean |
| fingerprint | AssistantPfrTiebreakingMetadata | Features used by the PrefulfillmentRanker’s scorer exclusively to break ties. | String | |
| sortedNameString | AssistantPfrTiebreakingMetadata | Features used by the PrefulfillmentRanker’s scorer exclusively to break ties. | String | |
| fulfillableDominantMedia | Whether this is a fulfillable, dominant Media intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| generatedByLegacyAquaDomain | Whether or not the intent was generated by a legacy Aqua domain that PFR should care about. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| hasAnswerGroup | Whether the interpretation has a Search answer group object, signifying it came from Search resolution. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| subIntentType | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | String | |
| isIntentFromOrbit | Whether the intent is from ORBIT. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| usesGroundingBox | Whether the interpretation should run through grounding box or not. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| effectiveArgSpanLength | The total effective length of the spans for the arguments used to construct the parse. May include vertical specific adjustments. Eg: For the query [delete my 7 p.m. alarm called chicken] and intent Delete_alarm(alarm_object=RD(category=AlarmObject( label=”chicken”, trigger_time_datetime=<< 7 PM >>))), the effective argument span is “7 p.m.” + “chicken” (total length of 13). | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | number |
| phase | Query understanding phase the intent was produced in. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | String |
| isFullyGrounded | Whether the intent is fully grounded. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isSageInNageIntent | Whether the intent is produced by the Sage IntentGenerator invoked by the NSP intent-generator (thus, Sage-in-NSP-invoking_Sage, or Sage-in-Nage). | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isSageDisabledIntent | Whether the intent is an intent marked disabled by the Sage IG. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| deepMediaDominant | Whether the intent is dominant according to NSP deep-media. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isVideoIntent | Whether the intent is a media object video intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| parsingScoreMse8BucketId | A ID corresponding to which bucket a given parsing score belongs in. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | integer |
| predictedIntentConfidence | Intent confidence predicted by the AssistantVerticalClassifier QRewrite servlet. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | number |
| nspIntentParseScore | Parse score generated by NSP. If NSP intent has been pruned due to dededuplication, It will have highest parse score for deduplicated intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| numConstraints | Signals as proposed in go/improved-grounding-signals. Sum of the number of constraints used by the Grounding Box to ground each variable. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| isPodcastIntent | Whether the intent is a podcast intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isDummyIntent | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean | |
| isScoreBasedIntent | Whether this intent is a score-based intent, relying on PFR for scoring and pruning to the top intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| platinumSource | Whether the intent comes from the Sage IntentGenerator’s “platinum” source, signifying high-confidence in quality. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| nspRank | Rank of the intent as reported by NSP. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | integer |
| dominant | Indicates interpretation dominance predicted by KScorer | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isRadioIntent | Whether the intent is a PlayMedia radio intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| searchDispatch | The determination made by the SearchDispatchingConfig as to whether and how this interpretation should be dispatched to Search. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | String |
| isHighConfidencePodcastIntent | Used for PFR manual rule to prefer high confidence podcast intent (e.g. topical, genre) over generic podcast intents. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| calibratedParsingScore | A parsing score that is independently calibrated by each parser/IG. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| intentNameAuisScoreExp | Assistant User Interaction Score which is aggregated using intent name from exp laelaps. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| inQueryMaxEffectiveArgSpanLength | This is a cross-intent feature which is calculated by iterating all intent candidates. This feature should be populated in post-IG stage (before GB). | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | number |
| pq2tVsAssistantIbstCosine | Cosine similarity between predicted query-to-term model and assistant intent-type-based salient terms. This is intended to be only used for ACE ranking and only populated for assistant traffic. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| isTvmIntent | Whether the intent is a media object tvm intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| numGroundedArgs | Number of grounded arguments the intent has, populated by the Grounding Box. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| numGroundableArgs | Grounding Signals. Number of groundable arguments the intent has, populated by the Grounding Box. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| intentType | intent_type differentiates between intents that share the top level intent name. For eg: for TV_FALLBACK_SEARCH_INTENT, the top level intent name must be “Find_media” and the media_object argument within it must be of type “Media_unspecified”. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | String |
| pq2tVsIbstCosine | Cosine similarity between predicted query-to-term model and intent-type-based salient terms. This is intended to be used as a backoff to pq2t_vs_qibst_cosine if it is missing. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| isNspIntent | Whether this interpretation was genearted by NSP. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isSageIntent | Whether this intent was generated by Sage. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| intentNameAuisScore | QUS intent-based ranking signals. Assistant User Interaction Score which is aggregated using intent name. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| kScore | Used for PFR manaul rule to prefer high kscore radio intent. The k-score comes from twiddled_ranking_scores in query interpretations. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | number |
| isAquaMediaIntent | Whether the intent aqua intent from media domain enabled in QBT | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isValidSmarthomeIntent | Whether the intent is a Smarthome-domain intent with valid device arguments. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| tiebreakingMetadata | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | AssistantPfrTiebreakingMetadata | |
| smarthomeIntentMetadata | SmartHome intent metadata used for the SmartHome business-rules twiddler. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | AssistantPfrSmartHomeIntentMetadata |
| numConstraintsSatisfied | Sum of the number of constraints satisfied for each variable. Depending on the match score for a constraint, this number can be fractional and is in the range [0, num_constraints]. Populated by the Grounding Box. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| isMediaControlIntent | Whether the intent is a media control intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| isPodcastGenericIntent | Used for PFR manual rule to prefer high confidence podcast intent (e.g. topical, genre) over generic podcast intents. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| maxHgrScoreAcrossBindingSets | The maximum score assigned by the Horizontal Grounding Ranker (HGR) across all of the intent’s binding sets. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | float |
| intentName | intent_name is used by PFR ensemble model. See go/pfr_ha_launch_doc | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | String |
| kscorerRank | The rank order of the interpretation as determined by kscorer. The kscorer-determined dominant interpretation, if any, gets a rank of 0. The remaining N interpretations get a rank of 1 through N. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | integer |
| isPlayGenericMusic | Whether the intent is a PlayGenericMusic-type intent. | AssistantPrefulfillmentRankerPrefulfillmentSignals | Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74 | boolean |
| name | [REQUIRED] The name of the list item. | AssistantProductivityListItem | A message to represent an item in a list. Just a basic string for now, but extensible for the future. | String |
| id | REQUIRED. An unique identifier for the attachment. We have a plan to index this field, so it’s marked as REQUIRED. Chat with opa-reminders-eng@ if you have a use case without an attachment ID. | 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. | String |
| link | 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. | AssistantRemindersAttachmentLink | |
| surfaceType | REQUIRED. Surface types this attachment should be shown. | 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. | list(String) |
| linkUrl | REQUIRED. The link to surface to frontends (e.g., Hubpage, notifications.) This could also be a surface-specific deeplink (be sure to set `surface_type` accordingly.) | AssistantRemindersAttachmentLink | String | |
| notificationText | 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. | AssistantRemindersAttachmentLink | AssistantRemindersNlgTemplateKey | |
| hasReferencedEntityAtCreation | Whether the reminder created has a referenced_entity attached to it or not(go/hub-memory-payload). Since we plan to set this in Assistant reminder creation path flow, in case later the referenced_entity is removed from the reminder, then this bit might still remain true. Also in case referenced_entity is later added to reminder(for example when referenced_entity is attached by Server), then also this bit might remain false. This bit will be used to *guess* if the user has a memory-enabled AGSA, thus we’ll surface the “open memory” button on hubpage. This check is not perfect, as the user might have other phones with older AGSA, so this is just a *best guess*. This field won’t be stored in Memory backend, and will not be populated back when retrieving reminders. | AssistantRemindersMemoryPayload | Since this is stored in BE, any update on this proto needs LGTM by ARIS storage owner | boolean |
| recordId | Id of record that is associated with Reminder. This will be set for all Assistant reminders created after the first launch of the Reminder Memory integration, see go/reminders-memory for more details. Also, this might apply to all other types of reminders. | AssistantRemindersMemoryPayload | Since this is stored in BE, any update on this proto needs LGTM by ARIS storage owner | String |
| messageSet | REQUIRED. | 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.). | String |
| templateName | REQUIRED. | 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.). | String |
| hasLocationInterpretation | Whether the nickname could also refer to a location. For example, “walmart”, “starbucks”. | AssistantTeleportTeleportNicknameSignals | boolean | |
| installInfo | Indicates whether the user has the app installed. | AssistantTeleportTeleportNicknameSignals | String | |
| isGeneric | 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). | AssistantTeleportTeleportNicknameSignals | boolean | |
| nicknameTier | The tier of the nickname. | AssistantTeleportTeleportNicknameSignals | String | |
| source | AssistantTeleportTeleportNicknameSignals | String | ||
| matchScore | Neural contact match similarity score. | AssistantVerticalsCommonContactMatchSignal | Neural contact match signals. | number |
| contextId | Actions-on-Google action context ID. See go/sdm-hospitality-design. | AssistantVerticalsHomeautomationProtoActionProjectConfig | Metadata for Actions-on-Google configuration. | String |
| agentId | The agent’s ID. Generally it is the agent’s Google pantheon project id. | AssistantVerticalsHomeautomationProtoAgentDeviceId | An agent + device pair that uniquely identifies a device. | String |
| deviceId | Device ID defined by the agent. | AssistantVerticalsHomeautomationProtoAgentDeviceId | An agent + device pair that uniquely identifies a device. | String |
| authType | AssistantVerticalsHomeautomationProtoAgentInformation | AgentInformation represents the details needed to support both 1P and 3P partnerships for Home Automation. Next ID: 7 | String | |
| deviceSource | AssistantVerticalsHomeautomationProtoAgentInformation | AgentInformation represents the details needed to support both 1P and 3P partnerships for Home Automation. Next ID: 7 | String | |
| executionPath | AssistantVerticalsHomeautomationProtoAgentInformation | AgentInformation represents the details needed to support both 1P and 3P partnerships for Home Automation. Next ID: 7 | String | |
| id | Unique Agent ID which maps to a specific Agent. Not using Agent Name here as it may change over time. | AssistantVerticalsHomeautomationProtoAgentInformation | AgentInformation represents the details needed to support both 1P and 3P partnerships for Home Automation. Next ID: 7 | String |
| key | Agent’s foreign key that uniquely identifies a user’s device. | AssistantVerticalsHomeautomationProtoAgentInformation | AgentInformation represents the details needed to support both 1P and 3P partnerships for Home Automation. Next ID: 7 | String |
| structureBasedRoutine | 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. | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutine | |
| attributeProtos | AssistantVerticalsHomeautomationProtoAttributes | LINT.IfChange(proto_attributes) | list(AssistantVerticalsHomeautomationProtoAttribute) | |
| enabled | AssistantVerticalsHomeautomationProtoCommonEventTrigger | LINT.IfChange(proto_event_trigger) Next id: 5 | boolean | |
| eventTriggerPayload | Detailed settings for the event trigger; unset if not applicable. | AssistantVerticalsHomeautomationProtoCommonEventTrigger | LINT.IfChange(proto_event_trigger) Next id: 5 | map |
| eventTriggerType | Different event type may have different settings. For example: * SCHEDULED will have event_trigger_payload of cs/symbol:assistant.verticals.voice_shortcut.proto.Schedule * LOCATION will have event_trigger_payload of cs/symbol:assistant.verticals.voice_shortcut.proto.LocationTriggerEvent | AssistantVerticalsHomeautomationProtoCommonEventTrigger | LINT.IfChange(proto_event_trigger) Next id: 5 | String |
| triggerSource | Unique identifier for the EventTrigger, e.g. SCHEDULED_ROUTINES. See the enum values of cs/symbol:WorkflowTriggerInput.TriggerSource | AssistantVerticalsHomeautomationProtoCommonEventTrigger | LINT.IfChange(proto_event_trigger) Next id: 5 | integer |
| enabled | Whether this Routine is enabled or not. If false, then this Routine can’t be triggered by Voice. | 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. | boolean |
| googlePreconfigWorkflowId | The unique identifier for a class of workflows. For example: * “sbr_001” => Away * “sbr_002” => Home * “category_template” => CUSTOM | 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. | String |
| language | 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. | String | |
| payload | Internal format payload primarily for Routines team use. | 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. | map |
| securityLevel | The security level of the Structure Based Routine as determined by the most security-sensitive task. | 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. | String |
| shared | 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. | boolean | |
| storagePayload | 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. | map | |
| structureId | 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. | String | |
| triggers | Voice or event triggers. | 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. | list(AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutineTrigger) |
| type | 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. | String | |
| uiPayload | UI format payload primarily for external team use. | 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. | map |
| eventTrigger | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutineTrigger | Next id: 3 | AssistantVerticalsHomeautomationProtoCommonEventTrigger | |
| voiceTrigger | AssistantVerticalsHomeautomationProtoCommonStructureBasedRoutineTrigger | Next id: 3 | AssistantVerticalsHomeautomationProtoCommonVoiceTrigger | |
| query | AssistantVerticalsHomeautomationProtoCommonVoiceTrigger | LINT.IfChange(proto_voice_trigger) Next id: 2 | String | |
| conciergeProductFeatures | AssistantVerticalsHomeautomationProtoConciergeFeatures | The Concierge features a structure is eligible for. See {@link home.graph.common.ConciergeFeatures}. | list(String) | |
| annotatedSpanDevice | The query span for device mention. | AssistantVerticalsHomeautomationProtoDeviceTargetingOutputQueryInfo | Next ID: 5 | String |
| annotatedSpanRoom | The query span for room mention. | AssistantVerticalsHomeautomationProtoDeviceTargetingOutputQueryInfo | Next ID: 5 | String |
| annotatedSpanStructure | The query span for structure mention. | AssistantVerticalsHomeautomationProtoDeviceTargetingOutputQueryInfo | Next ID: 5 | String |
| processedMentionedSpan | This field is from query_info.processed_mentioned_span in DTO. | AssistantVerticalsHomeautomationProtoDeviceTargetingOutputQueryInfo | Next ID: 5 | String |
| supportedStructureFeatures | The features that are available for a structure. Will only be populated if the item_type == STRUCTURE. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | AssistantVerticalsHomeautomationProtoSupportedStructureFeatures |
| traitRoutingHints | For SHED devices, some traits can only be executed on 3P cloud, e.g. “action.devices.traits.MediaInitiation”, “action.devices.traits.Channel” go/shed-per-trait-routing | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(HomeGraphCommonTraitRoutingHints) |
| parentNode | LINT.IfChange(home_graph_single_parent) At the moment, we just have a single string. In future this will expand with additional metadata from client or cloud execution data store. In today’s ‘tree’ HomeGraph each object has a single parent. In the future this may have a mesh for complex cases — zones, doors, etc — so we make this a repeated element today. LINT.ThenChange(//depot/google3/assistant/assistant_server/settings/user_defined_actions/footprints/footprint_accessor.cc:home_graph_single_parent) | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(String) |
| actionProjectConfigs | Custom actions that this item supports. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(AssistantVerticalsHomeautomationProtoActionProjectConfig) |
| zoneNameSaftDocument | SAFT Document with linguistic annotations for the zone name, if applicable. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | NlpSaftDocument |
| operationalNodeId | Operational CHIP Node ID that combines the fabric ID and node id in format of . (Hex format without 0x prefix, for example, 0F001234FA67AA39.1234ABCD1111DDDD). | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| saftDocument | SAFT Document with linguistic annotations for the primary device name. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | NlpSaftDocument |
| opaqueCustomData | Store custom data for agent calls here. This will likely be short-lived — we will replace this with calls to HGS. (Note: This may end up not temporary if we only need it for a couple partners — more efficient to have it on a few users than require HGS reads for all users. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| lanscanOptedIn | Whether local home platform should discover new devices via LAN for the structure. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | boolean |
| plural | We use this to determine if the synonyms matched in the aqua interpretation is plural. Then we will return disambiguate dialog or execute commands with all the targets. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(String) |
| deviceModelId | See note in home_graph.proto; loaded into DE now to avoid having to double-read assistant settings records as per go/smarthome-removing-assistant-settings | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| notificationSupportedByAgent | Indicates whether the device is capable of sending notifications. This field will be set by the agent (partner) on an incoming SYNC. If a device is not capable of generating notifications, the partner should set this flag to false. If a partner is not capable of calling ReportStateAndNotification to send notifications to Google, the partner should set this flag to false. If there is a user setting in the partner app to enable notifications and it is turned off, the partner should set this flag to false. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | boolean |
| parentType | The type of the parent. Currently only set for devices, to distinguish between structure and room parents. Items currently have only one parent, and entries after the first parent_type are ignored. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(String) |
| gcmExecutionAddress | GCM address for cloud execution across google cloud messaging rather than 3p cloud. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| smartDeviceManagementData | Data needed for SDM (fleet management). See go/enterprise-id-in-assistant. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | AssistantVerticalsHomeautomationProtoSmartDeviceManagementData |
| voiceMatchRequired | Set to which level of voice match is needed. Enum based on string input from the partner in json sync. Values accepted: “none” (but in this case partners won’t set it), “owner” [requires matching one of the creator gaia IDs], or “member” [any recognized voice ‘enrolled’ on the device]. This may expand; only “owner” is in use for first partner, Tile. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| personalizedNicknames | User-given nicknames for an entity (e.g. “My house”). These nicknames are unique to the gaia user. Nickname in DeviceInfo is per-entity level nickname, while personalized_nicknames is per-user per-entity. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | list(String) |
| primaryName | Which of the values was the original, user-provided name — or our disambiguated, cleaned-up version of it. This is what we use in TTS when we need to identify an object that wasn’t just spoken uniquely by the user — in disambiguation dialogue, or in response to a collective interrogative (e.g. “what lights are on in the kitchen?”) | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| attributes | Attributes data as provided from SYNC. This gets used in mutation and execution and in some potential cases, in biasing. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | map |
| hashValue | The hash value from go/de-consistency-check | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | String |
| willReportState | This device will report state; we can query realtime state from local HGS rather than slow QUERY intent to the 3p cloud. | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | boolean |
| matterUniqueId | Matter Unique ID. Contains VID/PID information | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 | AssistantVerticalsHomeautomationProtoMatterUniqueId |
| userDefinedDeviceType | The priority order of speech targeting: 1. user_defined_device_type 2. derived_device_type 3. device_type | AssistantVerticalsHomeautomationProtoHomeAutomation_MetaData | Next ID: 45 |