search_engine_specifics.proto 4.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  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.
  4. //
  5. // Sync protocol datatype extension for custom search engines.
  6. // If you change or add any fields in this file, update proto_visitors.h and
  7. // potentially proto_enum_conversions.{h, cc}.
  8. // Fields that are not used anymore should be marked [deprecated = true].
  9. syntax = "proto2";
  10. option java_multiple_files = true;
  11. option java_package = "org.chromium.components.sync.protocol";
  12. option optimize_for = LITE_RUNTIME;
  13. package sync_pb;
  14. // Properties of custom search engine sync objects.
  15. message SearchEngineSpecifics {
  16. // The description of the search engine.
  17. optional string short_name = 1;
  18. // The search engine keyword for omnibox access.
  19. optional string keyword = 2;
  20. // A URL to the favicon to show in the search engines options page.
  21. optional string favicon_url = 3;
  22. // The actual parameterized search engine query URL.
  23. optional string url = 4;
  24. // A flag signifying whether it is safe to automatically modify this search
  25. // engine entry or not.
  26. optional bool safe_for_autoreplace = 5;
  27. // The URL to the OSD file this search engine entry came from.
  28. optional string originating_url = 6;
  29. // The date this search engine entry was created. A UTC timestamp with units
  30. // in microseconds.
  31. optional int64 date_created = 7;
  32. // A list of supported input encodings.
  33. optional string input_encodings = 8;
  34. // Obsolete field. This used to represent whether or not this entry is shown
  35. // in the list of default search engines.
  36. optional bool deprecated_show_in_default_list = 9 [deprecated = true];
  37. // The parameterized URL that provides suggestions as the user types.
  38. optional string suggestions_url = 10;
  39. // The ID associated with the prepopulate data this search engine comes from.
  40. // Set to zero if it was not prepopulated.
  41. optional int32 prepopulate_id = 11;
  42. // DEPRECATED: Whether to autogenerate a keyword for the search engine or not.
  43. // Do not write to this field in the future. We preserve this for now so we
  44. // can read the field in order to migrate existing data that sets this bit.
  45. optional bool autogenerate_keyword = 12 [deprecated = true];
  46. // ID 13 reserved - previously used by |logo_id|, now deprecated.
  47. // Obsolete field. This used to represent whether or not this search engine
  48. // entry was created automatically by an administrator via group policy. This
  49. // notion no longer exists amongst synced search engines as we do not want to
  50. // sync managed search engines.
  51. // optional bool deprecated_created_by_policy = 14;
  52. optional string instant_url = 15 [deprecated = true];
  53. // ID 16 reserved - previously used by |id|, now deprecated.
  54. // The last time this entry was modified by a user. A UTC timestamp with units
  55. // in microseconds.
  56. optional int64 last_modified = 17;
  57. // The primary identifier of this search engine entry for Sync.
  58. optional string sync_guid = 18;
  59. // A list of URL patterns that can be used, in addition to |url|, to extract
  60. // search terms from a URL.
  61. repeated string alternate_urls = 19;
  62. optional string search_terms_replacement_key = 20 [deprecated = true];
  63. // The parameterized URL that provides image results according to the image
  64. // content or image URL provided by user.
  65. optional string image_url = 21;
  66. // The following post_params are comma-separated lists used to specify the
  67. // post parameters for the corresponding search URL.
  68. optional string search_url_post_params = 22;
  69. optional string suggestions_url_post_params = 23;
  70. optional string instant_url_post_params = 24 [deprecated = true];
  71. optional string image_url_post_params = 25;
  72. // The parameterized URL for a search provider specified new tab page.
  73. optional string new_tab_url = 26;
  74. enum ActiveStatus {
  75. // The default state when a SE is auto-added. Unspecified SE are inactive.
  76. ACTIVE_STATUS_UNSPECIFIED = 0;
  77. // The SE is active and can be triggered via the omnibox.
  78. ACTIVE_STATUS_TRUE = 1;
  79. // The SE has been manually set to inactive by the user.
  80. ACTIVE_STATUS_FALSE = 2;
  81. }
  82. // Whether a search engine is 'active' and can be triggered via the omnibox by
  83. // typing in the relevant keyword.
  84. optional ActiveStatus is_active = 27;
  85. // The ID associated with the starter pack engine. This is set to 0 if not a
  86. // starter pack engine.
  87. optional int32 starter_pack_id = 28;
  88. }