1// Copyright 2014 The Chromium Authors 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5syntax = "proto2"; 6 7option optimize_for = LITE_RUNTIME; 8option java_package = "org.chromium.components.metrics"; 9 10option java_outer_classname = "OmniboxEventProtos"; 11 12package metrics; 13 14import "omnibox_input_type.proto"; 15 16// Stores information about an omnibox interaction. 17// Next tag: 28 18message OmniboxEventProto { 19 // The timestamp for the event, in seconds. 20 // This value comes from Chromium's TimeTicks::Now(), which is an abstract 21 // time value that is guaranteed to always be non-decreasing (regardless of 22 // Daylight Saving Time or any other changes to the system clock). 23 // These numbers are only comparable within a session. To sequence events 24 // across sessions, order by the |session_id| from the 25 // ChromeUserMetricsExtension message. 26 optional int64 time_sec = 1; 27 28 // The id of the originating tab for this omnibox interaction. 29 // This is the current tab *unless* the user opened the target in a new tab. 30 // In those cases, this is unset. Tab ids are unique for a given session_id 31 // (in the containing protocol buffer ChromeUserMetricsExtensionProto). 32 optional int32 tab_id = 2; 33 34 // The number of characters the user had typed before autocompleting. 35 optional int32 typed_length = 3; 36 37 // Whether the user deleted text immediately before selecting an omnibox 38 // suggestion. This is usually the result of pressing backspace or delete. 39 optional bool just_deleted_text = 11; 40 41 // The number of terms that the user typed in the omnibox. 42 optional int32 num_typed_terms = 4; 43 44 // The index of the item that the user selected in the omnibox popup list. 45 // This corresponds the index of the |suggestion| below. 46 optional int32 selected_index = 5; 47 48 // Whether the user selected the option to switch tabs (or ignored it 49 // and navigated). If true, one or more |Suggestions| will have 50 // |has_tab_match| set as well, which must include the |selected_index|. 51 optional bool selected_tab_match = 17; 52 53 // DEPRECATED. Whether or not the top match was hidden in the omnibox 54 // suggestions dropdown. 55 optional bool DEPRECATED_is_top_result_hidden_in_dropdown = 14 56 [deprecated = true]; 57 58 // Whether the omnibox popup is open. It can be closed if, for instance, 59 // the user clicks in the omnibox and hits return to reload the same page. 60 // If the popup is closed, the suggestion list will contain only one item 61 // and selected_index will be 0 (pointing to that single item). Because 62 // paste-and-search/paste-and-go actions ignore the current content of the 63 // omnibox dropdown (if it is open) when they happen, we pretend the 64 // dropdown is closed when logging these. 65 optional bool is_popup_open = 15; 66 67 // True if this is a paste-and-search or paste-and-go action. (The codebase 68 // refers to both these types as paste-and-go.) 69 optional bool is_paste_and_go = 16; 70 71 // The length of the inline autocomplete text in the omnibox. 72 // The sum |typed_length| + |completed_length| gives the full length of the 73 // user-visible text in the omnibox. 74 // This field is only set for suggestions that are allowed to be the default 75 // match and omitted otherwise. The first suggestion is always allowed to 76 // be the default match. (This is an enforced constraint.) Hence, if 77 // |selected_index| == 0, then this field will always be set. 78 optional int32 completed_length = 6; 79 80 // The amount of time, in milliseconds, since the user first began modifying 81 // the text in the omnibox. If at some point after modifying the text, the 82 // user reverts the modifications (thus seeing the current web page's URL 83 // again), then writes in the omnibox again, this elapsed time should start 84 // from the time of the second series of modification. 85 optional int64 typing_duration_ms = 7; 86 87 // The amount of time, in milliseconds, since the last time the default 88 // (inline) match changed. This may be longer than the time since the 89 // last keystroke. (The last keystroke may not have changed the default 90 // match.) It may also be shorter than the time since the last keystroke 91 // because the default match might have come from an asynchronous 92 // provider. Regardless, it should always be less than or equal to 93 // the field |typing_duration_ms|. 94 optional int64 duration_since_last_default_match_update_ms = 13; 95 96 // The type of page the user was on when they used the omnibox. Or the type of 97 // page for which suggestions were prefetched from the server. 98 enum PageClassification { 99 // An invalid URL; shouldn't happen. 100 INVALID_SPEC = 0; 101 102 // chrome://newtab/. For modern versions of Chrome, this is only reported 103 // when an extension is replacing the new tab page. Otherwise, new tab 104 // page interactions will be reported as NTP_REALBOX, 105 // INSTANT_NTP_WITH_FAKEBOX_AS_STARTING_FOCUS or 106 // INSTANT_NTP_WITH_OMNIBOX_AS_STARTING_FOCUS. 107 // For old versions of Chrome, this was reported for the default New Tab 108 // Page. 109 NTP = 1; 110 111 // about:blank. 112 BLANK = 2; 113 114 // The user's home page. Note that if the home page is set to any 115 // of the new tab page versions or to about:blank, then we'll 116 // classify the page into those categories, not HOME_PAGE. 117 HOME_PAGE = 3; 118 119 // The catch-all entry of everything not included somewhere else 120 // on this list. 121 OTHER = 4; 122 123 // The instant new tab page. 124 OBSOLETE_INSTANT_NTP = 5; // DEPRECATED on August 2, 2013. 125 126 // The user is on a search result page that does search term replacement. 127 // This means the search terms are shown in the omnibox instead of the URL. 128 // In other words: Query in Omnibox is Active for this SRP. 129 SEARCH_RESULT_PAGE_DOING_SEARCH_TERM_REPLACEMENT = 6; 130 131 // The new tab page in which this omnibox interaction first started 132 // with the user having focus in the omnibox. 133 INSTANT_NTP_WITH_OMNIBOX_AS_STARTING_FOCUS = 7; 134 135 // The new tab page in which this omnibox interaction first started with the 136 // user having focus in the fakebox. This is replaced by NTP_REALBOX. 137 // DEPRECATED on Aug 17, 2020. 138 INSTANT_NTP_WITH_FAKEBOX_AS_STARTING_FOCUS = 8; 139 140 // The user is on a search result page that does not do search term 141 // replacement. This means the URL of the SRP is shown in the omnibox. 142 // In other words: Query in Omnibox is Inactive for this SRP. 143 SEARCH_RESULT_PAGE_NO_SEARCH_TERM_REPLACEMENT = 9; 144 145 // The user is on the home screen. 146 APP_HOME = 10; 147 148 // The user is in the search app. 149 APP_SEARCH = 11; 150 151 // The user is in the maps app. 152 APP_MAPS = 12; 153 154 // This omnibox interaction started with the user tapping the search button. 155 SEARCH_BUTTON_AS_STARTING_FOCUS = 13; 156 157 // This interaction started with the user focusing or typing in the search 158 // box of the ChromeOS app list (a.k.a., launcher). 159 CHROMEOS_APP_LIST = 14; 160 161 // The new tab page in which this omnibox interaction started with the user 162 // having focus in the realbox. 163 NTP_REALBOX = 15; 164 165 // Android's Search Widget started directly from Launcher. 166 ANDROID_SEARCH_WIDGET = 16; 167 168 // Android's Start surface homepage. 169 START_SURFACE_HOMEPAGE = 17; // DEPRECATED on Jun 17, 2022. 170 // New Tab with Omnibox focused with Android's start surface finale enabled. 171 START_SURFACE_NEW_TAB = 18; // DEPRECATED on Jun 17, 2022. 172 173 // Android's improved Search Widget with new suggestions. 174 ANDROID_SHORTCUTS_WIDGET = 19; 175 176 // The New Tab Page zero-prefix suggestion prefetch. 177 // Used for prefetching suggestions and should never appear in an 178 // OmniboxEventProto or any of its derived histograms. (PageClassification 179 // enum is used in other places too, and not only OmniboxEventProto.) 180 NTP_ZPS_PREFETCH = 20; 181 182 // Used for Journeys requests in its landing page, side Panel or the NTP. 183 // Should never appear in an OmniboxEventProto or any of its derived 184 // histograms. (PageClassification enum is used in other places too, and not 185 // only OmniboxEventProto.) 186 JOURNEYS = 21; 187 188 // The Search Results Page zero-prefix suggestion prefetch. 189 // Used for prefetching suggestions and should never appear in an 190 // OmniboxEventProto or any of its derived histograms. (PageClassification 191 // enum is used in other places too, and not only OmniboxEventProto.) 192 SRP_ZPS_PREFETCH = 22; 193 194 // The catch-all zero-prefix suggestion prefetch for everything other than 195 // NTP and SRP. 196 // Used for prefetching suggestions and should never appear in an 197 // OmniboxEventProto or any of its derived histograms. (PageClassification 198 // enum is used in other places too, and not only OmniboxEventProto.) 199 OTHER_ZPS_PREFETCH = 23; 200 201 // When adding new classifications, please consider adding them in 202 // chromium's chrome/browser/resources/omnibox/omnibox.html 203 // so that these new options are displayed on about:omnibox. 204 } 205 optional PageClassification current_page_classification = 10; 206 207 enum ModeType { 208 // Unknown type (should not be reported). 209 UNKNOWN_MODE = 0; 210 // This user is in web mode when looking for suggestions. 211 WEB_MODE = 1; 212 // This user is in image mode when looking for suggestions. 213 IMAGE_MODE = 2; 214 } 215 optional ModeType mode_type = 18; 216 217 optional OmniboxInputType input_type = 8; 218 219 // An enum used in multiple places below. 220 enum ProviderType { 221 UNKNOWN_PROVIDER = 0; // Unknown provider (should not reach here) 222 HISTORY_URL = 1; // URLs in history, or user-typed URLs 223 HISTORY_CONTENTS = 2; // Matches for page contents of pages in history 224 HISTORY_QUICK = 3; // Matches for recently or frequently visited pages 225 // in history 226 SEARCH = 4; // Search suggestions for the default search engine 227 KEYWORD = 5; // Keyword-triggered searches 228 BUILTIN = 6; // Built-in URLs, such as chrome://version 229 SHORTCUTS = 7; // Recently selected omnibox suggestions 230 EXTENSION_APPS = 8; // DEPRECATED. Suggestions from extensions or apps 231 CONTACT = 9; // DEPRECATED. The user's contacts 232 BOOKMARK = 10; // The user's bookmarks 233 ZERO_SUGGEST = 11; // Suggestions based on the current page 234 // This enum value is currently only used by Android GSA. It represents 235 // a suggestion from the phone powered by go/icing. 236 ON_DEVICE = 12; 237 // This enum value is currently only used by Android GSA. It represents 238 // a suggestion powered by a Chrome content provider. 239 ON_DEVICE_CHROME = 13; 240 CLIPBOARD = 14; // Suggestion coming from clipboard. 241 PHYSICAL_WEB = 15; // DEPRECATED. Suggestions triggered by URLs broadcast 242 // by nearby devices. 243 DOCUMENT = 16; // Suggestions for documents in a cloud corpus. 244 // Non personalized query suggestions generated from a lightweight on device 245 // head model. 246 ON_DEVICE_HEAD = 17; 247 // Zero-prefix query suggestions based on device local history. 248 ZERO_SUGGEST_LOCAL_HISTORY = 18; 249 // Only used by Android Chrome. Represents a suggestion showing query tiles 250 // that users can tap on for bulding queries. 251 QUERY_TILE = 19; 252 // Clusters generated on-device from the user's Chrome history. 253 HISTORY_CLUSTER = 20; 254 // Suggestions from history derived from input with automatic corrections. 255 HISTORY_FUZZY = 21; 256 // URLs amongst the user's currently open tabs. These are not separately 257 // attached TAB_SWITCH actions; they're full dedicated suggestions produced 258 // by the OpenTabProvider (used by @tabs keyword scope and CrOS launcher). 259 OPEN_TAB = 22; 260 // Tab switch actions that attach to matches when the URL is equivalent 261 // to a URL in another open tab. Note this is distinct from OPEN_TAB above. 262 // This is a pseudo-provider for a TabSwitchAction attached to a suggestion 263 // when AutocompleteResult::ConvertOpenTabMatches finds matching open tabs. 264 TAB_SWITCH = 23; 265 // Omnibox Pedals: specialized actions that may be attached to matches. 266 // This is a pseudo-provider for actions produced by OmniboxPedalProvider 267 // and attached to suggestions by AutocompleteResult::AttachPedalsToMatches. 268 PEDALS = 24; 269 } 270 271 // The result set displayed on the completion popup 272 // Next tag: 11 273 message Suggestion { 274 // Where does this result come from? 275 optional ProviderType provider = 1; 276 277 // What kind of result this is. 278 // This corresponds to the AutocompleteMatch::Type enumeration in 279 // components/omnibox/autocomplete_match.h 280 // (except for Android GSA result types). 281 enum ResultType { 282 UNKNOWN_RESULT_TYPE = 0; // Unknown type (should not reach here) 283 URL_WHAT_YOU_TYPED = 1; // The input as a URL 284 HISTORY_URL = 2; // A past page whose URL contains the input 285 HISTORY_TITLE = 3; // A past page whose title contains the input 286 HISTORY_BODY = 4; // DEPRECATED. A past page whose body 287 // contains the input 288 HISTORY_KEYWORD = 5; // A past page whose keyword contains the 289 // input 290 NAVSUGGEST = 6; // A suggested URL 291 // 292 // result_subtype_identifier is currently used 293 // for contextual zero-suggest suggestions 294 // provided by the experimental service (note 295 // that not all NAVSUUGGEST suggestions come 296 // from the experimental service). 297 // For subtype definitions, please contact 298 // gcomanici@chromium.org. 299 SEARCH_WHAT_YOU_TYPED = 7; // The input as a search query (with the 300 // default engine) 301 SEARCH_HISTORY = 8; // A past search (with the default engine) 302 // containing the input 303 SEARCH_SUGGEST = 9; // A suggested search (with the default 304 // engine) for a query. 305 SEARCH_OTHER_ENGINE = 10; // A search with a non-default engine 306 EXTENSION_APP = 11; // DEPRECATED. An Extension App with a 307 // title/url that contains the input. 308 CONTACT = 12; // One of the user's contacts 309 BOOKMARK_TITLE = 13; // A bookmark with a title/url that contains 310 // the input. 311 SEARCH_SUGGEST_ENTITY = 14; // A suggested search for an entity. 312 SEARCH_SUGGEST_TAIL = 15; // A suggested search to complete the tail of 313 // the query. 314 SEARCH_SUGGEST_PERSONALIZED = 16; // A personalized suggested search. 315 SEARCH_SUGGEST_PROFILE = 17; // A personalized suggested search for a 316 // Google+ profile. 317 APP_RESULT = 18; // Result from an installed app 318 // (eg: a gmail email). 319 // Used by Android GSA for on-device 320 // suggestion logging. 321 APP = 19; // An app result (eg: the gmail app). 322 // Used by Android GSA for on-device 323 // suggestion logging. 324 LEGACY_ON_DEVICE = 20; // An on-device result from a legacy 325 // provider. That is, this result is not 326 // from the on-device suggestion provider 327 // (go/icing). This field is 328 // used by Android GSA for on-device 329 // suggestion logging. 330 NAVSUGGEST_PERSONALIZED = 21; // A personalized url. 331 SEARCH_SUGGEST_ANSWER = 22; // DEPRECATED. Answers no longer have their 332 // own type but instead can be attached to 333 // suggestions of any type. 334 CALCULATOR = 23; // A calculator answer. 335 CLIPBOARD_URL = 24; // An URL based on the clipboard. 336 PHYSICAL_WEB = 25; // DEPRECATED. A Physical Web nearby URL. 337 PHYSICAL_WEB_OVERFLOW = 26; // DEPRECATED. An item representing multiple 338 // Physical Web nearby URLs. 339 DOCUMENT = 27; // An item representing a cloud document 340 // suggestion. 341 CLIPBOARD_TEXT = 28; // Text based on the clipboard. 342 CLIPBOARD_IMAGE = 29; // An image based on the clipboard. 343 TILE_SUGGESTION = 30; // A search query from Chrome Query Tiles 344 // feature. Only used by Android. 345 HISTORY_CLUSTER = 31; // A past page that is a member of a cluster 346 // (an aggregation of related searches and 347 // URLs from the user's history) that 348 // contains the input (the input might or 349 // might not also match the title or URL of 350 // this page). 351 OPEN_TAB = 32; // A currently open tab whose URL contains the input. 352 // Note: This is for dedicated matches produced by 353 // OpenTabProvider, not a general TAB_SWITCH action. 354 STARTER_PACK = 33; // A built-in URL suggestion specifically created for 355 // the starter pack keyword mode chip to attach to. 356 TAB_SWITCH = 34; // A tab-switch action (distinct from OPEN_TAB). 357 PEDAL = 35; // A pedal action. 358 } 359 optional ResultType result_type = 2; 360 361 // The relevance score for this suggestion. 362 optional int32 relevance = 3; 363 364 // How many times this result was typed in / selected from the omnibox 365 // in this profile. 366 // Only set for some providers and result_types. At the time of 367 // writing this comment, it is only set for HistoryURL and 368 // HistoryQuickProvider matches. 369 optional int32 typed_count = 5; 370 371 // Whether this item is starred (bookmarked) in this profile. 372 optional bool is_starred = 4 [deprecated = true]; 373 374 // Whether this item is disabled in the UI (not clickable). 375 optional bool is_disabled = 6; 376 377 // Used to identify the specific source / type for suggestions by the 378 // suggest server. The meaning of individual values is determined by the 379 // provider of each suggestion type and is different for every suggestion 380 // type. See enum ResultType above for more details. 381 optional int32 result_subtype_identifier = 7; 382 383 // Whether the suggestion presented in the match, regardless of type, 384 // matched an open tab. 385 optional bool has_tab_match = 8; 386 387 // Whether this suggestion came associated with a keyword. Does not include 388 // suggestions that came from the default search engine unless the search 389 // engine was explicitly invoked. As two common examples, 390 // |is_keyword_suggestion| will be true for suggestions from explicitly- 391 // invoked suggestions (whether from a search engine or an extension). It 392 // will also be true for suggestions from a keyword that wasn't explicitly 393 // requested. For example, if a user has Google as their default search 394 // engine, the input "bing testing" will often show a suggestion to "Search 395 // Bing for testing" in the dropdown. This suggestion will be marked as 396 // |is_keyword_suggestion|. 397 optional bool is_keyword_suggestion = 9; 398 399 // Signals for machine learning scoring. 400 // See details: http://shortn/_B21YgmkLs9. 401 // Currently, this message is only populated for URL suggestions 402 // (excluding Navsuggest and Document URLs) and only when there is a click 403 // on a URL suggestion. 404 // Only recorded on desktop platforms (Windows, Mac, Linux, ChromeOS). 405 // Next tag: 25 406 message ScoringSignals { 407 // Number of times the URL was navigated to using the Omnibox for this 408 // profile on this device, and all other devices syncing with this 409 // profile. Only include typed visits from the last 90 days. Discounted by 410 // a time-decaying factor with a 30-day half-life based on the last visit 411 // timestamp. 412 optional int32 typed_count = 1; 413 // Number of times the URL was visited in general for this profile on this 414 // device. Note that this will soon be across syncing devices with the 415 // rollout of full history sync in 2023. Only include visits from the last 416 // 90 days. Discounted by a time-decaying factor with a 30-day half-life 417 // based on the last visit timestamp. 418 optional int32 visit_count = 2; 419 // Elapsed time since last visit for this profile on this device. Uses the 420 // local client-side timestamps. Can be unreliable as local times can 421 // change in between different runs of Chrome. 422 optional int64 elapsed_time_last_visit_secs = 3; 423 // Number of times the suggestion was visited with the current input or 424 // prefix of it for this profile on this device. 425 // Discounted by a time-decaying factor with a 1-week half-life based on 426 // the last visit timestamp. 427 optional int32 shortcut_visit_count = 4; 428 // Length of the shortest shortcut text. 429 // Useful in comparison with |typed_length|. 430 optional int32 shortest_shortcut_len = 5; 431 // Elapsed time since last shortcut visit for this profile on this device. 432 // Uses the local client-side timestamps. Can be unreliable as local times 433 // can change in between different runs of Chrome. 434 optional int64 elapsed_time_last_shortcut_visit_sec = 6; 435 // URL points to the root page of a website, i.e., no query, path words, 436 // or references after "/". 437 optional bool is_host_only = 7; 438 // Number of bookmarks for this profile with this URL. 439 optional int32 num_bookmarks_of_url = 8; 440 // Position of the first matched bookmark title term. 441 // E.g. 4 for input 'x' and title "0123x56". 442 // Not set when there is no match in the bookmark title. 443 optional int32 first_bookmark_title_match_position = 9; 444 // Total length of matched strings in the bookmark title. Can be larger 445 // than the input text length. The input text is split by whitespaces, and 446 // each input word is matched against the title separately. Their matching 447 // lengths are summed. Similarly for other text matching signals below. 448 // E.g. 9 for input "[abc] ijk [xyz]" and title "[abc] def [xyz] - [xyz]". 449 // Set to 0 when there is no match in the title. 450 optional int32 total_bookmark_title_match_length = 10; 451 // Number of input terms matched by bookmark title. Take the maximum when 452 // there are multiple matching bookmarks of this URL. 453 // E.g., 1 for input "[a] b" and bookmark title "[a] book title". 454 // Not set when the user does not have this URL bookmarked. 455 optional int32 num_input_terms_matched_by_bookmark_title = 11; 456 // Position of the first matched URL substring. 457 // URL scheme or TLD matches are excluded, though those characters are 458 // counted when assessing match position. E.g., 11 for 't' in 459 // "https://hos[t].com" Not set when there is no URL match. 460 optional int32 first_url_match_position = 12; 461 // Total length of the matched URL strings. Can be longer than the input 462 // string. E.g., Given input "ab abc" and url "abc.com/ab", total is 7 (4 463 // for "ab" in "[ab]c.com/[ab]" and 3 for "abc" in 464 // "[abc].com"). Set to 0 when there is no URL string match. 465 optional int32 total_url_match_length = 13; 466 // One word matches host at a word boundary. E.g., true for input "[h] a" 467 // and "[h].com", Set to false when there are matches in the host but none 468 // at word boundaries. E.g., false for input "a" and "h[a].com". Not set 469 // when there is no host match. 470 optional bool host_match_at_word_boundary = 14; 471 // Total length of the matched host substrings. 472 // Can be larger than the input text. 473 // E.g., 3 for input "h a" and "[h]ost[aa].com". 474 // Set to 0 when there is no host match. 475 optional int32 total_host_match_length = 15; 476 // Total length of the matched substrings in the path at word boundaries. 477 // Can be larger than the input text. E.g. 3 for 'p' in 478 // 'a.com/[p]ath_[p]ath/[p]ath'. Set to 0 when there are no such matches. 479 optional int32 total_path_match_length = 16; 480 // Total length of the matched substrings in the query_or_ref at word 481 // boundaries. Can be larger than the input text. 482 // E.g., 3 for input '[qu] [a]' and 'a.com/a?[qu]ery_[a]'. 483 // Set to 0 when there are no such matches. 484 optional int32 total_query_or_ref_match_length = 17; 485 // Total length of the matched substrings in the page title at word 486 // boundaries. Can be larger than the input text. 487 // E.g., 2 for input "[a] [t] x" and page title "[a]bc [t]itle". 488 // Set to 0 when there is no title match. 489 optional int32 total_title_match_length = 18; 490 // Has matches that are not in schemes (e.g., "https") or "www". 491 optional bool has_non_scheme_www_match = 19; 492 // Number of input terms matched by title. 493 // E.g., 1 for input "[a] b" and title "[a] title [a]". 494 // Useful in comparison with |num_typed_terms|. 495 optional int32 num_input_terms_matched_by_title = 20; 496 // Number of input terms matched by url. 497 // Useful in comparison with |num_typed_terms|. 498 // E.g., 1 for input "[a] b" and url "[a].com". 499 optional int32 num_input_terms_matched_by_url = 21; 500 // Length of url. E.g., 22 for "https://www.host.com/p". 501 optional int32 length_of_url = 22; 502 // Site engagement score for the site the URL is on. See 503 // https://www.chromium.org/developers/design-documents/site-engagement/ 504 optional float site_engagement = 23; 505 // True if url can be default match. 506 // Currently, this requires single-term input, and match needs to begin 507 // immediately after '', scheme, or 'http://www' in the URL, e.g., given 508 // input 'w', true for "https://www.[w]sj.com" or "[w]ww.a.com", false for 509 // "host[w].com". ref: 510 // https://source.chromium.org/chromium/chromium/src/+/main:components/omnibox/browser/scored_history_match.cc;l=187?q=inline%20autocomplete 511 optional bool allowed_to_be_default_match = 24; 512 } 513 optional ScoringSignals scoring_signals = 10; 514 } 515 repeated Suggestion suggestion = 9; 516 517 // A data structure that holds per-provider information, general information 518 // not associated with a particular result. 519 // Next tag: 6 520 message ProviderInfo { 521 // Which provider generated this ProviderInfo entry. 522 optional ProviderType provider = 1; 523 524 // The provider's done() value, i.e., whether it's completed processing 525 // the query. Providers which don't do any asynchronous processing 526 // will always be done. 527 optional bool provider_done = 2; 528 529 // The set of field trials that have triggered in the most recent query, 530 // possibly affecting the shown suggestions. Each element is a hash 531 // of the corresponding field trial name. 532 // See chrome/browser/autocomplete/search_provider.cc for a specific usage 533 // DEPRECATED with crrev.com/c/4126664 1/4/23; replaced by 534 // `feature_triggered`. 535 // example. 536 repeated fixed32 field_trial_triggered = 3 [deprecated = true]; 537 538 // Same as above except that the set of field trials is a union of all field 539 // trials that have triggered within the current omnibox session including 540 // the most recent query. 541 // See AutocompleteController::ResetSession() for more details on the 542 // definition of a session. 543 // See chrome/browser/autocomplete/search_provider.cc for a specific usage 544 // example. 545 // DEPRECATED with crrev.com/c/4126664 1/4/23; replaced by 546 // `feature_triggered_in_session`. 547 repeated fixed32 field_trial_triggered_in_session = 4 [deprecated = true]; 548 549 // The number of times this provider returned a non-zero number of 550 // suggestions during this omnibox session. 551 // Note that each provider may define a session differently for its 552 // purposes. 553 optional int32 times_returned_results_in_session = 5; 554 } 555 // A list of diagnostic information about each provider. Providers 556 // will appear at most once in this list. 557 repeated ProviderInfo provider_info = 12; 558 559 // Whether the Omnibox was in keyword mode, however it was entered. 560 optional bool in_keyword_mode = 19; 561 562 // How the Omnibox got into keyword mode. Not present if not in keyword 563 // mode. 564 enum KeywordModeEntryMethod { 565 INVALID = 0; 566 TAB = 1; // Select a suggestion that provides a keyword hint 567 // and press Tab. 568 SPACE_AT_END = 2; // Type a complete keyword and press Space. 569 SPACE_IN_MIDDLE = 3; // Press Space in the middle of an input in order to 570 // separate it into a keyword and other text. 571 KEYBOARD_SHORTCUT = 4; // Press ^K. 572 QUESTION_MARK = 5; // Press Question-mark without any other input. 573 CLICK_HINT_VIEW = 6; // Select a suggestion that provides a keyword hint 574 // and click the reminder that one can press Tab. 575 TAP_HINT_VIEW = 7; // Select a suggestion that provides a keyword hint 576 // and touch the reminder that one can press Tab. 577 SELECT_SUGGESTION = 8; // Select a keyword suggestion, such as by arrowing 578 // or tabbing to it. 579 } 580 optional KeywordModeEntryMethod keyword_mode_entry_method = 20; 581 582 // Whether the omnibox input is a search query that is started 583 // by clicking on a image tile. 584 optional bool is_query_started_from_tile = 21; 585 586 enum Feature { 587 RICH_AUTOCOMPLETION = 0; 588 SHORT_BOOKMARK_SUGGESTIONS_BY_TOTAL_INPUT_LENGTH = 2; 589 FUZZY_URL_SUGGESTIONS = 3; 590 HISTORY_CLUSTER_SUGGESTION = 4; 591 DOMAIN_SUGGESTIONS = 5; 592 // Whether the `SearchProvider` response included: 593 // '"google:fieldtrialtriggered":true'. 594 REMOTE_SEARCH_FEATURE = 6; 595 // Like `REMOTE_SEARCH_FEATURE`, but for the `ZeroSearchProvider`. 596 REMOTE_ZERO_SUGGEST_FEATURE = 7; 597 SHORTCUT_BOOST = 8; 598 REMOTE_SECONDARY_ZERO_SUGGEST = 9; 599 ML_URL_SCORING = 10; 600 COMPANY_ENTITY_ADJUSTMENT = 11; 601 } 602 // The set of features triggered in the most recent query. Each element is a 603 // value of `Features` enum. 604 repeated int32 legacy_feature_triggered = 24 [deprecated = true]; 605 606 // Like above except that the set of features is a union of all features that 607 // triggered within the current omnibox session including the most recent 608 // query. See `AutocompleteController::ResetSession()` for more details on the 609 // definition of a session. 610 repeated int32 legacy_feature_triggered_in_session = 22 [deprecated = true]; 611 612 // The set of features triggered in the most recent query. 613 repeated Feature feature_triggered = 25; 614 615 // Like above except that the set of features is a union of all features that 616 // triggered within the current omnibox session including the most recent 617 // query. See `AutocompleteController::ResetSession()` for more details on the 618 // definition of a session. 619 repeated Feature feature_triggered_in_session = 26; 620 621 // Profile data of the user. Currently, only logged when there is a URL click. 622 message ProfileData { 623 // Total number of bookmarks in the profile this omnibox interaction took 624 // place in. 625 optional int32 total_num_bookmarks = 1; 626 // Total number of URLs stored in the history database in the profile this 627 // omnibox interaction took place in. 628 optional int32 total_num_history_urls = 2; 629 // Is signed into the browser. Set to false for Guest and Incognito 630 // profiles. Not set when signed-in status is unknown. 631 optional bool is_signed_into_browser = 3; 632 // Is sync-enabled. 633 optional bool is_sync_enabled = 4; 634 } 635 optional ProfileData profile_data = 23; 636 637 // The position of the omnibox. 638 enum OmniboxPosition { 639 // Unknown position (should not be reported). 640 UNKNOWN_POSITION = 0; 641 // The omnibox is on the top edge of the screen. 642 TOP_POSITION = 1; 643 // The omnibox is on the bottom edge of the screen. 644 BOTTOM_POSITION = 2; 645 } 646 // The position of the steady state (unfocused) omnibox. Logged on iOS only; 647 // will be set on iOS with the BottomOmniboxSteadyStateIOS experiment. 648 // TODO(christianxu): Update this on experiment cleanup. 649 optional OmniboxPosition steady_state_omnibox_position = 27; 650} 651