third_party/omnibox_proto/groups.proto - chromium/src.git - Git at Google

 // Copyright 2022 The Chromium Authors
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

 syntax = 'proto2';

 option optimize_for = LITE_RUNTIME;
 option java_package = 'org.chromium.components.omnibox';
 option java_outer_classname = 'GroupsProto';

 package omnibox;

 // Suggestion group configurations supported by Chrome Omnibox. Contains
 // information about how to display the suggestion groups.
 message GroupConfig {
   // The optional header text the group must appear under.
   optional string header_text = 1;

   enum SideType {
     DEFAULT_PRIMARY = 0;
     SECONDARY = 1;
   }

   // Indicates the primary or secondary column of suggestions.
   optional SideType side_type = 2;

   enum RenderType {
     DEFAULT_VERTICAL = 0;
     HORIZONTAL = 1;
     GRID = 2;
   }

   // Indicates how the group will be rendered.
   optional RenderType render_type = 3;

   enum Visibility {
     DEFAULT_VISIBLE = 0;
     HIDDEN = 1;
   }

   // Indicates whether the group is initially hidden (collapsed).
   optional Visibility visibility = 4;

   // Indicates the reason why this suggestion shows up.
   optional uint32 why_this_result_reason = 5;

   // The section of the list where the group belongs.
   // This field is set by Chrome and should not be populated in GWS.
   optional GroupSection section = 6;

   // Next ID: 7
 }

 // Contains information about the suggestion groups supported by Chrome Omnibox.
 // Specifically the mapping from suggestion group IDs (GroupId) to suggestion
 // group configurations (GroupConfig).
 message GroupsInfo {
   map<uint32, GroupConfig> group_configs = 1;
 }

 // Suggestion group IDs supported by Chrome Omnibox. These entries must not
 // be removed or renumbered.
 enum GroupId {
   GROUP_INVALID = -1;

   // Reserved for Polaris zero-prefix suggestions.
   // Produced by ZeroSuggestProvider.
   GROUP_PREVIOUS_SEARCH_RELATED = 10000;
   GROUP_PREVIOUS_SEARCH_RELATED_ENTITY_CHIPS = 10001;
   GROUP_TRENDS = 10002;
   GROUP_TRENDS_ENTITY_CHIPS = 10003;
   GROUP_RELATED_QUERIES = 10004;
   GROUP_VISITED_DOC_RELATED = 10005;
   GROUP_MULTIMODAL = 10006;
   GROUP_CONTEXTUAL_SEARCH = 10007;
   GROUP_CONTEXTUAL_SEARCH_ACTION = 10008;
   GROUP_POLARIS_RESERVED_MAX = 19999;

   // Mobile-specific auxiliary suggestions.
   GROUP_MOBILE_SEARCH_READY_OMNIBOX = 30000;
   GROUP_MOBILE_MOST_VISITED = 30001;
   GROUP_MOBILE_CLIPBOARD = 30002;
   GROUP_MOBILE_QUERY_TILES = 30003;  // E.g. "News", "Films", "Sports", ...
   GROUP_MOBILE_RICH_ANSWER = 30004;  // Visually rich answer suggestion.
   GROUP_MOBILE_OPEN_TABS = 30005;    // Tabs which are currently open.
   GROUP_MOBILE_CROSS_DEVICE_TABS = 30006;  // Tabs opened on another device.
   GROUP_MOBILE_BOOKMARKS = 30007;
   GROUP_MOBILE_HISTORY = 30008;

   // Reserved for personalized zero-prefix suggestions.
   // Produced by LocalHistoryZeroSuggestProvider and maybe ZeroSuggestProvider.
   GROUP_PERSONALIZED_ZERO_SUGGEST = 40000;

   // Reserved for MIA zero-prefix suggestions and personalized zero-prefix
   // suggestions with MIA.
   GROUP_MIA_RECOMMENDATIONS = 45000;
   GROUP_PERSONALIZED_ZERO_SUGGEST_WITH_MIA = 45001;

   // Cross platform suggestions with vanilla visual representation (i.e.
   // vertical, primary column, and no header), but useful for sorting.
   GROUP_STARTER_PACK = 50000;
   GROUP_SEARCH = 50001;
   GROUP_OTHER_NAVS = 50002;  // E.g., bookmarks, history, etc.
   GROUP_DOCUMENT = 50003;    // E.g., Drive docs, slides, sheets, etc.
   GROUP_HISTORY_CLUSTER = 50004;
   GROUP_MOST_VISITED = 50005;
   GROUP_RECENTLY_CLOSED_TABS = 50006;

   // IPH suggestions that appear in zero-prefix.  These suggestions are
   // informational only and do not trigger a search or navigation.
   GROUP_ZERO_SUGGEST_IN_PRODUCT_HELP = 60000;

   // Extension suggestions that appear in non-zps input. These suggestions
   // appear when ExperimentalOmniboxLabs is enabled. Every extension should
   // have a unique group in order to have its own header.
   GROUP_UNSCOPED_EXTENSION_1 = 70000;
   GROUP_UNSCOPED_EXTENSION_2 = 70001;
 }

 // Suggestion group sections determine the order in which suggestion groups
 // appear in the result list relative to one another. A group with a section of
 // a lower numeric value comes before a group with a section of a higher value.
 enum GroupSection {
   // The default section. Any group with this section is placed above all other
   // groups. Must not be removed or renumbered and must have the lowest value.
   SECTION_DEFAULT = 0;

   // Mobile-specific auxiliary suggestions. These suggestions are sourced on
   // device, and appear above any other content.
   // SECTION_MOBILE_VERBATIM hosts:
   // Search Ready Omnibox / Verbatim match
   SECTION_MOBILE_VERBATIM = 1;

   // SECTION_MOBILE_CLIPBOARD hosts:
   // - Text you copied
   // - Link you copied
   // - Image you copied
   SECTION_MOBILE_CLIPBOARD = 2;

   // Clipboard suggestions
   // SECTION_MOBILE_MOST_VISITED hosts a horizontal carousel with:
   // - Most Visited Tiles
   // - Organic Repeatable Queries
   SECTION_MOBILE_MOST_VISITED = 3;

   // historical zero-prefix suggestions. May be overwritten by the dynamically
   // assigned section for GROUP_PERSONALIZED_ZERO_SUGGEST if reported by server.
   SECTION_PERSONALIZED_ZERO_SUGGEST = 4;

   // A contiguous range reserved for remote zero-prefix suggestions.
   // The sections are dynamically assigned to the groups found in the server
   // response based on the order in which they appear in the results.
   // Accommodates up to 10 distinct suggestion groups in the server response.
   SECTION_REMOTE_ZPS_1 = 5;
   SECTION_REMOTE_ZPS_2 = 6;
   SECTION_REMOTE_ZPS_3 = 7;
   SECTION_REMOTE_ZPS_4 = 8;
   SECTION_REMOTE_ZPS_5 = 9;
   SECTION_REMOTE_ZPS_6 = 10;
   SECTION_REMOTE_ZPS_7 = 11;
   SECTION_REMOTE_ZPS_8 = 12;
   SECTION_REMOTE_ZPS_9 = 13;
   SECTION_REMOTE_ZPS_10 = 14;

   // Query tiles - a carousel with high-level query recommendations.
   SECTION_MOBILE_QUERY_TILES = 15;
   // Visually rich answer suggestion presented as a standalone card.
   SECTION_MOBILE_RICH_ANSWER = 16;

   // IPH suggestions that appear in zero-prefix.  These suggestions are
   // informational only and do not trigger a search or navigation.
   SECTION_ZERO_SUGGEST_IN_PRODUCT_HELP = 17;

   // Cross platform suggestions with vanilla visual representation (i.e.
   // vertical, primary column, and no header), but useful for sorting.
   SECTION_STARTER_PACK = 100;
   SECTION_SEARCH = 101;
   SECTION_OTHER_NAVS = 102;
   SECTION_DOCUMENT = 103;
   SECTION_HISTORY_CLUSTER = 104;
   SECTION_MOST_VISITED = 105;
   SECTION_RECENTLY_CLOSED_TABS = 106;

   // Android-specific auxiliary suggestions. These suggestions are sourced on
   // device, and appear above any other content.
   SECTION_MOBILE_OPEN_TABS = 200;
   SECTION_MOBILE_BOOKMARKS = 201;
   SECTION_MOBILE_HISTORY = 202;

   // Unscoped extension suggestions. These suggestions are sourced from
   // extensions for non zps input when ExperimentalOmniboxLabs is enabled.
   SECTION_UNSCOPED_EXTENSION_1 = 300;
   SECTION_UNSCOPED_EXTENSION_2 = 301;
 }
	// Copyright 2022 The Chromium Authors
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	syntax = 'proto2';

	option optimize_for = LITE_RUNTIME;
	option java_package = 'org.chromium.components.omnibox';
	option java_outer_classname = 'GroupsProto';

	package omnibox;

	// Suggestion group configurations supported by Chrome Omnibox. Contains
	// information about how to display the suggestion groups.
	message GroupConfig {
	// The optional header text the group must appear under.
	optional string header_text = 1;

	enum SideType {
	DEFAULT_PRIMARY = 0;
	SECONDARY = 1;
	}

	// Indicates the primary or secondary column of suggestions.
	optional SideType side_type = 2;

	enum RenderType {
	DEFAULT_VERTICAL = 0;
	HORIZONTAL = 1;
	GRID = 2;
	}

	// Indicates how the group will be rendered.
	optional RenderType render_type = 3;

	enum Visibility {
	DEFAULT_VISIBLE = 0;
	HIDDEN = 1;
	}

	// Indicates whether the group is initially hidden (collapsed).
	optional Visibility visibility = 4;

	// Indicates the reason why this suggestion shows up.
	optional uint32 why_this_result_reason = 5;

	// The section of the list where the group belongs.
	// This field is set by Chrome and should not be populated in GWS.
	optional GroupSection section = 6;

	// Next ID: 7
	}

	// Contains information about the suggestion groups supported by Chrome Omnibox.
	// Specifically the mapping from suggestion group IDs (GroupId) to suggestion
	// group configurations (GroupConfig).
	message GroupsInfo {
	map<uint32, GroupConfig> group_configs = 1;
	}

	// Suggestion group IDs supported by Chrome Omnibox. These entries must not
	// be removed or renumbered.
	enum GroupId {
	GROUP_INVALID = -1;

	// Reserved for Polaris zero-prefix suggestions.
	// Produced by ZeroSuggestProvider.
	GROUP_PREVIOUS_SEARCH_RELATED = 10000;
	GROUP_PREVIOUS_SEARCH_RELATED_ENTITY_CHIPS = 10001;
	GROUP_TRENDS = 10002;
	GROUP_TRENDS_ENTITY_CHIPS = 10003;
	GROUP_RELATED_QUERIES = 10004;
	GROUP_VISITED_DOC_RELATED = 10005;
	GROUP_MULTIMODAL = 10006;
	GROUP_CONTEXTUAL_SEARCH = 10007;
	GROUP_CONTEXTUAL_SEARCH_ACTION = 10008;
	GROUP_POLARIS_RESERVED_MAX = 19999;

	// Mobile-specific auxiliary suggestions.
	GROUP_MOBILE_SEARCH_READY_OMNIBOX = 30000;
	GROUP_MOBILE_MOST_VISITED = 30001;
	GROUP_MOBILE_CLIPBOARD = 30002;
	GROUP_MOBILE_QUERY_TILES = 30003; // E.g. "News", "Films", "Sports", ...
	GROUP_MOBILE_RICH_ANSWER = 30004; // Visually rich answer suggestion.
	GROUP_MOBILE_OPEN_TABS = 30005; // Tabs which are currently open.
	GROUP_MOBILE_CROSS_DEVICE_TABS = 30006; // Tabs opened on another device.
	GROUP_MOBILE_BOOKMARKS = 30007;
	GROUP_MOBILE_HISTORY = 30008;

	// Reserved for personalized zero-prefix suggestions.
	// Produced by LocalHistoryZeroSuggestProvider and maybe ZeroSuggestProvider.
	GROUP_PERSONALIZED_ZERO_SUGGEST = 40000;

	// Reserved for MIA zero-prefix suggestions and personalized zero-prefix
	// suggestions with MIA.
	GROUP_MIA_RECOMMENDATIONS = 45000;
	GROUP_PERSONALIZED_ZERO_SUGGEST_WITH_MIA = 45001;

	// Cross platform suggestions with vanilla visual representation (i.e.
	// vertical, primary column, and no header), but useful for sorting.
	GROUP_STARTER_PACK = 50000;
	GROUP_SEARCH = 50001;
	GROUP_OTHER_NAVS = 50002; // E.g., bookmarks, history, etc.
	GROUP_DOCUMENT = 50003; // E.g., Drive docs, slides, sheets, etc.
	GROUP_HISTORY_CLUSTER = 50004;
	GROUP_MOST_VISITED = 50005;
	GROUP_RECENTLY_CLOSED_TABS = 50006;

	// IPH suggestions that appear in zero-prefix. These suggestions are
	// informational only and do not trigger a search or navigation.
	GROUP_ZERO_SUGGEST_IN_PRODUCT_HELP = 60000;

	// Extension suggestions that appear in non-zps input. These suggestions
	// appear when ExperimentalOmniboxLabs is enabled. Every extension should
	// have a unique group in order to have its own header.
	GROUP_UNSCOPED_EXTENSION_1 = 70000;
	GROUP_UNSCOPED_EXTENSION_2 = 70001;
	}

	// Suggestion group sections determine the order in which suggestion groups
	// appear in the result list relative to one another. A group with a section of
	// a lower numeric value comes before a group with a section of a higher value.
	enum GroupSection {
	// The default section. Any group with this section is placed above all other
	// groups. Must not be removed or renumbered and must have the lowest value.
	SECTION_DEFAULT = 0;

	// Mobile-specific auxiliary suggestions. These suggestions are sourced on
	// device, and appear above any other content.
	// SECTION_MOBILE_VERBATIM hosts:
	// Search Ready Omnibox / Verbatim match
	SECTION_MOBILE_VERBATIM = 1;

	// SECTION_MOBILE_CLIPBOARD hosts:
	// - Text you copied
	// - Link you copied
	// - Image you copied
	SECTION_MOBILE_CLIPBOARD = 2;

	// Clipboard suggestions
	// SECTION_MOBILE_MOST_VISITED hosts a horizontal carousel with:
	// - Most Visited Tiles
	// - Organic Repeatable Queries
	SECTION_MOBILE_MOST_VISITED = 3;

	// historical zero-prefix suggestions. May be overwritten by the dynamically
	// assigned section for GROUP_PERSONALIZED_ZERO_SUGGEST if reported by server.
	SECTION_PERSONALIZED_ZERO_SUGGEST = 4;

	// A contiguous range reserved for remote zero-prefix suggestions.
	// The sections are dynamically assigned to the groups found in the server
	// response based on the order in which they appear in the results.
	// Accommodates up to 10 distinct suggestion groups in the server response.
	SECTION_REMOTE_ZPS_1 = 5;
	SECTION_REMOTE_ZPS_2 = 6;
	SECTION_REMOTE_ZPS_3 = 7;
	SECTION_REMOTE_ZPS_4 = 8;
	SECTION_REMOTE_ZPS_5 = 9;
	SECTION_REMOTE_ZPS_6 = 10;
	SECTION_REMOTE_ZPS_7 = 11;
	SECTION_REMOTE_ZPS_8 = 12;
	SECTION_REMOTE_ZPS_9 = 13;
	SECTION_REMOTE_ZPS_10 = 14;

	// Query tiles - a carousel with high-level query recommendations.
	SECTION_MOBILE_QUERY_TILES = 15;
	// Visually rich answer suggestion presented as a standalone card.
	SECTION_MOBILE_RICH_ANSWER = 16;

	// IPH suggestions that appear in zero-prefix. These suggestions are
	// informational only and do not trigger a search or navigation.
	SECTION_ZERO_SUGGEST_IN_PRODUCT_HELP = 17;

	// Cross platform suggestions with vanilla visual representation (i.e.
	// vertical, primary column, and no header), but useful for sorting.
	SECTION_STARTER_PACK = 100;
	SECTION_SEARCH = 101;
	SECTION_OTHER_NAVS = 102;
	SECTION_DOCUMENT = 103;
	SECTION_HISTORY_CLUSTER = 104;
	SECTION_MOST_VISITED = 105;
	SECTION_RECENTLY_CLOSED_TABS = 106;

	// Android-specific auxiliary suggestions. These suggestions are sourced on
	// device, and appear above any other content.
	SECTION_MOBILE_OPEN_TABS = 200;
	SECTION_MOBILE_BOOKMARKS = 201;
	SECTION_MOBILE_HISTORY = 202;

	// Unscoped extension suggestions. These suggestions are sourced from
	// extensions for non zps input when ExperimentalOmniboxLabs is enabled.
	SECTION_UNSCOPED_EXTENSION_1 = 300;
	SECTION_UNSCOPED_EXTENSION_2 = 301;
	}