components/suggestions/proto/suggestions.proto

   1 // Copyright 2014 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 syntax = "proto2";
   6
   7 option optimize_for = LITE_RUNTIME;
   8
   9 package suggestions;
  10
  11 // Providers are identified with an ID.
  12 enum ProviderId {
  13   SERVER0 = 0;
  14   // SERVER1 through 8 were never used.
  15   SERVER8 = 8;
  16   SERVER9 = 9;
  17   SERVER10 = 10;
  18   SERVER11 = 11;
  19 }
  20
  21 // The SuggestionsProfile is a protobuf response from the server that contains
  22 // the list of suggestions to be presented to the user.
  23 //
  24 // Next tag: 2
  25 message SuggestionsProfile {
  26   repeated ChromeSuggestion suggestions = 1;
  27 }
  28
  29 // The suggestions for this user, ordered from best to worst.
  30 //
  31 // Next tag: 6
  32 message ChromeSuggestion {
  33   // The URL of the suggestion.
  34   optional string url = 1;
  35
  36   // Title of the suggestion.
  37   optional string title = 2;
  38
  39   // The URL of the favicon associated with this page.
  40   optional string favicon_url = 3;
  41
  42   // The URL of the thumbnail associated with this page.
  43   optional string thumbnail = 4;
  44
  45   // The provider(s) responsible for this suggestion.
  46   repeated ProviderId providers = 5;
  47
  48   // The timestamp (usec) at which this suggestion ceases to be valid.
  49   optional int64 expiry_ts = 7;
  50 }
  51
  52 // A list of URLs that should be filtered from the SuggestionsProfile.
  53 //
  54 // Next tag: 2
  55 message SuggestionsBlacklist {
  56   // URLs that make up the blacklist.
  57   repeated string urls = 1;
  58 }
  59
  60 // ImageData contains the data to represent a website image (e.g. thumbnail).
  61 //
  62 // Next tag: 3
  63 message ImageData {
  64   // The URL of the website represented by this image.
  65   optional string url = 1;
  66
  67   // Bitmap bytes, encoded as JPEG.
  68   optional bytes data = 2;
  69 }