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