Protocol Documentation

Table of Contents

• feedback-fusion-v1.proto

  • CheckboxOptions

  • CheckboxResponse

  • CreateFieldRequest

  • CreatePromptRequest

  • CreateResponsesRequest

  • CreateResponsesRequest.DataEntry

  • CreateTargetRequest

  • DataExportRequest

  • DataExportResponse

  • DeleteFieldRequest

  • DeletePromptRequest

  • DeleteTargetRequest

  • Field

  • FieldOptions

  • FieldPage

  • FieldResponse

  • FieldResponseList

  • GetFieldsRequest

  • GetPromptRequest

  • GetPromptsRequest

  • GetResponsesRequest

  • GetTargetRequest

  • GetTargetsRequest

  • NumberOptions

  • NumberResponse

  • Prompt

  • PromptPage

  • PromptResponse

  • RangeOptions

  • RangeResponse

  • RatingOptions

  • RatingResponse

  • ResponseData

  • ResponsePage

  • ResponsePage.DataEntry

  • SelectionOptions

  • SelectionResponse

  • Target

  • TargetPage

  • TextOptions

  • TextResponse

  • UpdateFieldRequest

  • UpdatePromptRequest

  • UpdateTargetRequest

  • UserInfoResponse

  • UserInfoResponse.PermissionsEntry

  • CheckboxStyle

  • FieldType

  • FeedbackFusionV1

  • PublicFeedbackFusionV1

• Scalar Value Types

Top

feedback-fusion-v1.proto

CheckboxOptions

Field	Type	Label	Description
style	CheckboxStyle
default_state	bool

CheckboxResponse

Field	Type	Label	Description
checked	bool

CreateFieldRequest

Field	Type	Label	Description
prompt	string
title	string
description	string	optional
field_type	FieldType
options	FieldOptions

CreatePromptRequest

Field	Type	Label	Description
target	string
title	string
description	string
active	bool

CreateResponsesRequest

Field	Type	Label	Description
data	CreateResponsesRequest.DataEntry	repeated
prompt	string

CreateResponsesRequest.DataEntry

Field	Type	Label	Description
key	string
value	ResponseData

CreateTargetRequest

Field	Type	Label	Description
name	string
description	string	optional

DataExportRequest

Field	Type	Label	Description
targets	string	repeated

DataExportResponse

Field	Type	Label	Description
export	string

DeleteFieldRequest

Field	Type	Label	Description
id	string

DeletePromptRequest

Field	Type	Label	Description
id	string

DeleteTargetRequest

Field	Type	Label	Description
id	string

Field

Field	Type	Label	Description
id	string
prompt	string
title	string
description	string	optional
field_type	FieldType
options	FieldOptions
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp

FieldOptions

Field	Type	Label	Description
text	TextOptions
rating	RatingOptions
checkbox	CheckboxOptions
selection	SelectionOptions
range	RangeOptions
number	NumberOptions

FieldPage

Field	Type	Label	Description
page_token	int32
next_page_token	int32
page_size	int32
total	int32
fields	Field	repeated

FieldResponse

Field	Type	Label	Description
id	string
response	string
field	string
data	ResponseData

FieldResponseList

Field	Type	Label	Description
data	FieldResponse	repeated

GetFieldsRequest

Field	Type	Label	Description
page_token	int32
page_size	int32
prompt	string

GetPromptRequest

Field	Type	Label	Description
id	string

GetPromptsRequest

Field	Type	Label	Description
page_token	int32
page_size	int32
target	string

GetResponsesRequest

Field	Type	Label	Description
page_token	int32
page_size	int32
prompt	string

GetTargetRequest

Field	Type	Label	Description
id	string

GetTargetsRequest

Field	Type	Label	Description
page_token	int32
page_size	int32
query	string

NumberOptions

Field	Type	Label	Description
min	int32
max	int32
placeholder	string

NumberResponse

Field	Type	Label	Description
number	int32

Prompt

Field	Type	Label	Description
id	string
title	string
description	string
target	string
active	bool
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp

PromptPage

Field	Type	Label	Description
page_token	int32
next_page_token	int32
page_size	int32
total	int32
prompts	Prompt	repeated

PromptResponse

Field	Type	Label	Description
id	string
prompt	string
created_at	google.protobuf.Timestamp

RangeOptions

Field	Type	Label	Description
min	int32
max	int32

RangeResponse

Field	Type	Label	Description
start	int32
end	int32

RatingOptions

Field	Type	Label	Description
max	int32

RatingResponse

Field	Type	Label	Description
rating	int32

ResponseData

Field	Type	Label	Description
text	TextResponse
rating	RatingResponse
checkbox	CheckboxResponse
selection	SelectionResponse
range	RangeResponse
number	NumberResponse

ResponsePage

Field	Type	Label	Description
page_token	int32
next_page_token	int32
page_size	int32
total	int32
data	ResponsePage.DataEntry	repeated

ResponsePage.DataEntry

Field	Type	Label	Description
key	string
value	FieldResponseList

SelectionOptions

Field	Type	Label	Description
values	string	repeated
multiple	bool
combobox	bool

SelectionResponse

Field	Type	Label	Description
values	string	repeated

Target

Field	Type	Label	Description
id	string
name	string
description	string	optional
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp

TargetPage

Field	Type	Label	Description
page_token	int32
next_page_token	int32
page_size	int32
total	int32
targets	Target	repeated

TextOptions

Field	Type	Label	Description
placeholder	string
lines	int32

TextResponse

Field	Type	Label	Description
text	string

UpdateFieldRequest

Field	Type	Label	Description
options	FieldOptions
title	string	optional
description	string	optional
id	string

UpdatePromptRequest

Field	Type	Label	Description
id	string
active	bool	optional
description	string	optional
title	string	optional

UpdateTargetRequest

Field	Type	Label	Description
id	string
name	string	optional
description	string	optional

UserInfoResponse

Field	Type	Label	Description
permissions	UserInfoResponse.PermissionsEntry	repeated

UserInfoResponse.PermissionsEntry

Field	Type	Label	Description
key	string
value	bool

CheckboxStyle

Name	Number	Description
NORMAL	0
SWITCH	1

FieldType

Name	Number	Description
TEXT	0
RATING	1
CHECKBOX	2
SELECTION	3
RANGE	4
NUMBER	5

FeedbackFusionV1

uses oidc authentication

Method Name	Request Type	Response Type	Description
CreateTarget	CreateTargetRequest	Target
GetTarget	GetTargetRequest	Target
GetTargets	GetTargetsRequest	TargetPage
UpdateTarget	UpdateTargetRequest	Target
DeleteTarget	DeleteTargetRequest	.google.protobuf.Empty
CreatePrompt	CreatePromptRequest	Prompt
GetPrompts	GetPromptsRequest	PromptPage
UpdatePrompt	UpdatePromptRequest	Prompt
DeletePrompt	DeletePromptRequest	.google.protobuf.Empty
CreateField	CreateFieldRequest	Field
GetFields	GetFieldsRequest	FieldPage
UpdateField	UpdateFieldRequest	Field
DeleteField	DeleteFieldRequest	.google.protobuf.Empty
GetResponses	GetResponsesRequest	ResponsePage
GetUserInfo	.google.protobuf.Empty	UserInfoResponse
ExportData	DataExportRequest	DataExportResponse

PublicFeedbackFusionV1

does not use oidc authentication

Method Name	Request Type	Response Type	Description
GetActiveFields	GetFieldsRequest	FieldPage
GetPrompt	GetPromptRequest	Prompt
CreateResponses	CreateResponsesRequest	PromptResponse

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)