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 // Notice that the tags on this proto must match the ones on the server side.
  25 //
  26 // Next tag: 2
  27 message SuggestionsProfile {
  28   repeated ChromeSuggestion suggestions = 1;
  29
  30   // Timestamp when the profile was generated (usec).
  31   optional int64 timestamp = 16;
  32 }
  33
  34 // The suggestions for this user, ordered from best to worst.
  35 //
  36 // Next tag: 15
  37 message ChromeSuggestion {
  38   // The URL of the suggestion.
  39   optional string url = 1;
  40
  41   // Title of the suggestion.
  42   optional string title = 2;
  43
  44   // The URL of the favicon associated with this page.
  45   optional string favicon_url = 3;
  46
  47   // The URL of the thumbnail associated with this page.
  48   optional string thumbnail = 4;
  49
  50   // The provider(s) responsible for this suggestion.
  51   repeated ProviderId providers = 5;
  52
  53   // The timestamp (usec) at which this suggestion ceases to be valid.
  54   optional int64 expiry_ts = 7;
  55
  56   // URL that should be pinged back when the suggestion is shown/clicked.
  57   optional string impression_url = 13;
  58   optional string click_url = 14;
  59 }
  60
  61 // A list of URLs that should be filtered from the SuggestionsProfile.
  62 //
  63 // Next tag: 2
  64 message SuggestionsBlacklist {
  65   // URLs that make up the blacklist.
  66   repeated string urls = 1;
  67 }
  68
  69 // ImageData contains the data to represent a website image (e.g. thumbnail).
  70 //
  71 // Next tag: 3
  72 message ImageData {
  73   // The URL of the website represented by this image.
  74   optional string url = 1;
  75
  76   // Bitmap bytes, encoded as JPEG.
  77   optional bytes data = 2;
  78 }