1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 // Sync protocol datatype extension for custom search engines.
7 // Update proto_value_conversions{.h,.cc,_unittest.cc} if you change
8 // any fields in this file.
12 option optimize_for = LITE_RUNTIME;
13 option retain_unknown_fields = true;
17 // Properties of custom search engine sync objects.
18 message SearchEngineSpecifics {
19 // The description of the search engine.
20 optional string short_name = 1;
21 // The search engine keyword for omnibox access.
22 optional string keyword = 2;
23 // A URL to the favicon to show in the search engines options page.
24 optional string favicon_url = 3;
25 // The actual parameterized search engine query URL.
26 optional string url = 4;
27 // A flag signifying whether it is safe to automatically modify this search
28 // engine entry or not.
29 optional bool safe_for_autoreplace = 5;
30 // The URL to the OSD file this search engine entry came from.
31 optional string originating_url = 6;
32 // The date this search engine entry was created. A UTC timestamp with units
34 optional int64 date_created = 7;
35 // A list of supported input encodings.
36 optional string input_encodings = 8;
37 // Whether this entry is shown in the list of default search engines or not.
38 optional bool show_in_default_list = 9;
39 // The parameterized URL that provides suggestions as the user types.
40 optional string suggestions_url = 10;
41 // The ID associated with the prepopulate data this search engine comes from.
42 // Set to zero if it was not prepopulated.
43 optional int32 prepopulate_id = 11;
44 // DEPRECATED: Whether to autogenerate a keyword for the search engine or not.
45 // Do not write to this field in the future. We preserve this for now so we
46 // can read the field in order to migrate existing data that sets this bit.
47 optional bool autogenerate_keyword = 12;
48 // ID 13 reserved - previously used by |logo_id|, now deprecated.
49 // Obsolete field. This used to represent whether or not this search engine
50 // entry was created automatically by an administrator via group policy. This
51 // notion no longer exists amongst synced search engines as we do not want to
52 // sync managed search engines.
53 // optional bool deprecated_created_by_policy = 14;
54 // The parameterized URL that is used for Instant results.
55 optional string instant_url = 15;
56 // ID 16 reserved - previously used by |id|, now deprecated.
57 // The last time this entry was modified by a user. A UTC timestamp with units
59 optional int64 last_modified = 17;
60 // The primary identifier of this search engine entry for Sync.
61 optional string sync_guid = 18;
62 // A list of URL patterns that can be used, in addition to |url| and
63 // |instant_url|, to extract search terms from a URL.
64 repeated string alternate_urls = 19;
65 // Parameter that, if present in a search URL, indicates that Chrome should
66 // perform search terms replacement in the omnibox.
67 optional string search_terms_replacement_key = 20;
68 // The parameterized URL that provides image results according to the image
69 // content or image URL provided by user.
70 optional string image_url = 21;
72 // The following post_params are comma-separated lists used to specify the
73 // post parameters for the corresponding search URL.
74 optional string search_url_post_params = 22;
75 optional string suggestions_url_post_params = 23;
76 optional string instant_url_post_params = 24;
77 optional string image_url_post_params = 25;
79 // The parameterized URL for a search provider specified new tab page.
80 optional string new_tab_url = 26;