components/feedback/proto/extension.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 // Messages sent from extension to feedback server as JSON.
   6
   7 syntax = "proto2";
   8
   9 option optimize_for = LITE_RUNTIME;
  10
  11 package userfeedback;
  12
  13 import "common.proto";
  14 import "chrome.proto";
  15 import "dom.proto";
  16 import "math.proto";
  17 import "web.proto";
  18
  19 // Sent along with request for extension page when user attempts to open
  20 // feedback tab.
  21 message ExtensionPageRequestParams {
  22
  23   required ExtensionDetails extension_details = 1;
  24
  25   // Url of the page (without request params) that user wants to open
  26   // feedback tool for.
  27   required string url = 2;
  28 };
  29
  30 message PostedScreenshot {
  31
  32   required string mime_type = 1;
  33
  34   required Dimensions dimensions = 2;
  35
  36   optional string base64_content = 3;
  37
  38   optional bytes binary_content = 4;
  39 };
  40
  41 // Contains data about possible errors on the client side.
  42 // Describes number of attempts to send feedback and possible error codes/
  43 // exceptions which occured.
  44 message ExtensionErrors {
  45
  46   required int32 number_of_attempts = 1;
  47
  48   required string errors = 2;
  49 };
  50
  51 // Sent when user hits final submit button.
  52 message ExtensionSubmit {
  53
  54   required CommonData common_data = 1;
  55
  56   required WebData web_data = 2;
  57
  58   required int32 type_id = 3;
  59
  60   optional PostedScreenshot screenshot = 4;
  61
  62   optional ChromeData chrome_data = 14;
  63
  64   repeated ProductSpecificBinaryData product_specific_binary_data = 15;
  65
  66   optional string category_tag = 16;
  67
  68   optional int32 product_id = 17;
  69
  70   optional string bucket = 18;
  71 };
  72
  73 // A query for suggestions, sent when the user hits the preview button.
  74 message SuggestQuery {
  75
  76   required CommonData common_data = 1;
  77
  78   required WebData web_data = 2;
  79
  80   required int32 type_id = 3;
  81
  82   optional HtmlDocument html_document_structure = 4;
  83
  84   optional ChromeData chrome_data = 5;
  85 };