Protocol Documentation

Table of Contents

• common/resource.proto

  • ProtoResourceKind

• feedback-fusion-event-v1/event/batch.proto

  • ProtoEvent

  • ProtoEventBatch

  • ProtoEventType

• feedback-fusion-event-v1/event/resource_modified.proto

  • ProtoResourceModifiedEvent

  • ProtoResourceModificationOperation

• feedback-fusion-event-v1/service.proto

  • FeedbackFusionIndexerV1

• feedback-fusion-v1/audit.proto

  • AuditVersionPage

  • GetAuditVersionsRequest

  • ProtoAuditVersion

  • RollbackResourceRequest

  • ProtoAuditAction

• feedback-fusion-v1/user.proto

  • ProtoUser

• feedback-fusion-v1/export.proto

  • DataExportRequest
  • DataExportResponse

• feedback-fusion-v1/authorization.proto

  • CreateResourceAuthorizationRequest

  • DeleteResourceAuthorizationRequest

  • ExportResourceAuthorizationsRequest

  • GetResourceAuthorizationRequest

  • GetResourceAuthorizationsRequest

  • ProtoResourceAuthorization

  • ProtoResourceAuthorizationData

  • ResourceAuthorizationExportResponse

  • ResourceAuthorizationList

  • ResourceAuthorizationPage

  • UpdateResourceAuthorizationRequest

  • ProtoAuthorizationGrant

  • ProtoAuthorizationType

• feedback-fusion-v1/target.proto

  • CreateTargetRequest
  • DeleteTargetRequest
  • GetTargetRequest
  • GetTargetsRequest
  • ProtoTarget
  • TargetPage
  • UpdateTargetRequest

• feedback-fusion-v1/response.proto

  • CheckboxResponse
  • CreateResponsesRequest
  • CreateResponsesRequest.DataEntry
  • FieldResponseList
  • GetResponsesRequest
  • NumberResponse
  • ProtoFieldResponse
  • ProtoPromptResponse
  • RangeResponse
  • RatingResponse
  • ResponseData
  • ResponsePage
  • ResponsePage.DataEntry
  • SelectionResponse
  • TextResponse
  • UserInfoResponse
  • UserInfoResponse.PermissionsEntry

• feedback-fusion-v1/service.proto

  • FeedbackFusionV1
  • PublicFeedbackFusionV1

• feedback-fusion-v1/field.proto

  • CreateFieldRequest

  • DeleteFieldRequest

  • FieldPage

  • GetFieldsRequest

  • ProtoCheckboxOptions

  • ProtoField

  • ProtoFieldOptions

  • ProtoNumberOptions

  • ProtoRangeOptions

  • ProtoRatingOptions

  • ProtoSelectionOptions

  • ProtoTextOptions

  • UpdateFieldRequest

  • ProtoCheckboxStyle

  • ProtoFieldType

• feedback-fusion-v1/prompt.proto

  • CreatePromptRequest
  • DeletePromptRequest
  • GetPromptRequest
  • GetPromptsRequest
  • PromptPage
  • ProtoPrompt
  • UpdatePromptRequest

• feedback-fusion-v1/resource.proto

  • ProtoResource

• Scalar Value Types

Top

common/resource.proto

ProtoResourceKind

Name	Number	Description
UNKNOWN	0
TARGET	1
PROMPT	2
FIELD	3
EXPORT	4
AUTHORIZE	5
RESPONSE	6

Top

feedback-fusion-event-v1/event/batch.proto

ProtoEvent

Field	Type	Label	Description
created_at	google.protobuf.Timestamp
event_type	ProtoEventType
resource_modified_event	ProtoResourceModifiedEvent

ProtoEventBatch

Field	Type	Label	Description
events	ProtoEvent	repeated

ProtoEventType

Name	Number	Description
UNKNOWN	0
RESOURCE_MODIFIED	1

Top

feedback-fusion-event-v1/event/resource_modified.proto

ProtoResourceModifiedEvent

Field	Type	Label	Description
operation	ProtoResourceModificationOperation
id	string
resource_kind	common.ProtoResourceKind
data	bytes
made_by	string

ProtoResourceModificationOperation

Name	Number	Description
CREATE	0
UPDATE	1
DELETE	2
ROLLBACK	3

Top

feedback-fusion-event-v1/service.proto

FeedbackFusionIndexerV1

Method Name	Request Type	Response Type	Description
SendBatch	ProtoEventBatch	.google.protobuf.Empty

Top

feedback-fusion-v1/audit.proto

AuditVersionPage

Field	Type	Label	Description
page_token	int32
next_page_token	int32
page_size	int32
total	int32
audit_versions	ProtoAuditVersion	repeated

GetAuditVersionsRequest

Field	Type	Label	Description
page_token	int32
page_size	int32
resource_id	string
resource_type	common.ProtoResourceKind

ProtoAuditVersion

Field	Type	Label	Description
id	string
resource_id	string
resource_type	common.ProtoResourceKind
action	ProtoAuditAction
data	ProtoResource
version	int32
created_at	google.protobuf.Timestamp
made_by	ProtoUser

RollbackResourceRequest

Field	Type	Label	Description
resource_id	string
resource_type	common.ProtoResourceKind
version	int32

ProtoAuditAction

Name	Number	Description
UNKNOWN	0
CREATE	1
UPDATE	2
DELETE	3
ROLLBACK	4

Top

feedback-fusion-v1/user.proto

ProtoUser

Field	Type	Label	Description
id	string
username	string

Top

feedback-fusion-v1/export.proto

DataExportRequest

Field	Type	Label	Description
targets	string	repeated

DataExportResponse

Field	Type	Label	Description
export	string

Top

feedback-fusion-v1/authorization.proto

CreateResourceAuthorizationRequest

Field	Type	Label	Description
resource_kind	common.ProtoResourceKind
resource_id	string	repeated
authorization_data	ProtoResourceAuthorizationData

DeleteResourceAuthorizationRequest

Field	Type	Label	Description
id	string

ExportResourceAuthorizationsRequest

Field	Type	Label	Description
ids	string	repeated

GetResourceAuthorizationRequest

Field	Type	Label	Description
id	string

GetResourceAuthorizationsRequest

Field	Type	Label	Description
page_token	int32
page_size	int32
value	string	optional
authorization_type	ProtoAuthorizationType	optional

ProtoResourceAuthorization

Field	Type	Label	Description
id	string
resource_kind	common.ProtoResourceKind
resource_id	string	optional
authorization_type	ProtoAuthorizationType
authorization_grant	ProtoAuthorizationGrant
value	string
updated_at	google.protobuf.Timestamp
created_at	google.protobuf.Timestamp

ProtoResourceAuthorizationData

Field	Type	Label	Description
type	ProtoAuthorizationType
grant	ProtoAuthorizationGrant	repeated
values	string	repeated

ResourceAuthorizationExportResponse

Field	Type	Label	Description
export	string

ResourceAuthorizationList

Field	Type	Label	Description
authorizations	ProtoResourceAuthorization	repeated

ResourceAuthorizationPage

Field	Type	Label	Description
page_token	int32
next_page_token	int32
page_size	int32
total	int32
authorizations	ProtoResourceAuthorization	repeated

UpdateResourceAuthorizationRequest

Field	Type	Label	Description
id	string
resource_id	string	optional
authorization_type	ProtoAuthorizationType	optional
authorization_grant	ProtoAuthorizationGrant	optional
value	string	optional

ProtoAuthorizationGrant

Name	Number	Description
WRITE	0
READ	1
List	2
All	3

ProtoAuthorizationType

Name	Number	Description
TYPE_SCOPE	0
TYPE_GROUP	1
TYPE_SUBJECT	2

Top

feedback-fusion-v1/target.proto

CreateTargetRequest

Field	Type	Label	Description
name	string
description	string	optional

DeleteTargetRequest

Field	Type	Label	Description
id	string

GetTargetRequest

Field	Type	Label	Description
id	string

GetTargetsRequest

Field	Type	Label	Description
page_token	int32
page_size	int32
query	string

ProtoTarget

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	ProtoTarget	repeated

UpdateTargetRequest

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

Top

feedback-fusion-v1/response.proto

CheckboxResponse

Field	Type	Label	Description
checked	bool

CreateResponsesRequest

Field	Type	Label	Description
data	CreateResponsesRequest.DataEntry	repeated
prompt	string

CreateResponsesRequest.DataEntry

Field	Type	Label	Description
key	string
value	ResponseData

FieldResponseList

Field	Type	Label	Description
data	ProtoFieldResponse	repeated

GetResponsesRequest

Field	Type	Label	Description
page_token	int32
page_size	int32
prompt	string

NumberResponse

Field	Type	Label	Description
number	int32

ProtoFieldResponse

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

ProtoPromptResponse

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

RangeResponse

Field	Type	Label	Description
start	int32
end	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

SelectionResponse

Field	Type	Label	Description
values	string	repeated

TextResponse

Field	Type	Label	Description
text	string

UserInfoResponse

Field	Type	Label	Description
permissions	UserInfoResponse.PermissionsEntry	repeated

UserInfoResponse.PermissionsEntry

Field	Type	Label	Description
key	string
value	bool

Top

feedback-fusion-v1/service.proto

FeedbackFusionV1

uses oidc authentication

Method Name	Request Type	Response Type	Description
CreateTarget	CreateTargetRequest	ProtoTarget
GetTarget	GetTargetRequest	ProtoTarget
GetTargets	GetTargetsRequest	TargetPage
UpdateTarget	UpdateTargetRequest	ProtoTarget
DeleteTarget	DeleteTargetRequest	.google.protobuf.Empty
CreatePrompt	CreatePromptRequest	ProtoPrompt
GetPrompts	GetPromptsRequest	PromptPage
UpdatePrompt	UpdatePromptRequest	ProtoPrompt
DeletePrompt	DeletePromptRequest	.google.protobuf.Empty
CreateField	CreateFieldRequest	ProtoField
GetFields	GetFieldsRequest	FieldPage
UpdateField	UpdateFieldRequest	ProtoField
DeleteField	DeleteFieldRequest	.google.protobuf.Empty
GetResponses	GetResponsesRequest	ResponsePage
GetUserInfo	.google.protobuf.Empty	UserInfoResponse
ExportData	DataExportRequest	DataExportResponse
CreateResourceAuthorization	CreateResourceAuthorizationRequest	ResourceAuthorizationList
GetResourceAuthorizations	GetResourceAuthorizationsRequest	ResourceAuthorizationPage
GetResourceAuthorization	GetResourceAuthorizationRequest	ProtoResourceAuthorization
UpdateResourceAuthorization	UpdateResourceAuthorizationRequest	ProtoResourceAuthorization
DeleteResourceAuthorization	DeleteResourceAuthorizationRequest	.google.protobuf.Empty
ExportResourceAuthorizations	ExportResourceAuthorizationsRequest	ResourceAuthorizationExportResponse
GetAuditVersions	GetAuditVersionsRequest	AuditVersionPage
RollbackResource	RollbackResourceRequest	.google.protobuf.Empty

PublicFeedbackFusionV1

does not use oidc authentication

Method Name	Request Type	Response Type	Description
GetActiveFields	GetFieldsRequest	FieldPage
GetPrompt	GetPromptRequest	ProtoPrompt
CreateResponses	CreateResponsesRequest	ProtoPromptResponse

Top

feedback-fusion-v1/field.proto

CreateFieldRequest

Field	Type	Label	Description
prompt	string
title	string
description	string	optional
field_type	ProtoFieldType
options	ProtoFieldOptions

DeleteFieldRequest

Field	Type	Label	Description
id	string

FieldPage

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

GetFieldsRequest

Field	Type	Label	Description
page_token	int32
page_size	int32
prompt	string

ProtoCheckboxOptions

Field	Type	Label	Description
style	ProtoCheckboxStyle
default_state	bool

ProtoField

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

ProtoFieldOptions

Field	Type	Label	Description
text	ProtoTextOptions
rating	ProtoRatingOptions
checkbox	ProtoCheckboxOptions
selection	ProtoSelectionOptions
range	ProtoRangeOptions
number	ProtoNumberOptions

ProtoNumberOptions

Field	Type	Label	Description
min	int32
max	int32
placeholder	string

ProtoRangeOptions

Field	Type	Label	Description
min	int32
max	int32

ProtoRatingOptions

Field	Type	Label	Description
max	int32

ProtoSelectionOptions

Field	Type	Label	Description
values	string	repeated
multiple	bool
combobox	bool

ProtoTextOptions

Field	Type	Label	Description
placeholder	string
lines	int32

UpdateFieldRequest

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

ProtoCheckboxStyle

Name	Number	Description
NORMAL	0
SWITCH	1

ProtoFieldType

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

Top

feedback-fusion-v1/prompt.proto

CreatePromptRequest

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

DeletePromptRequest

Field	Type	Label	Description
id	string

GetPromptRequest

Field	Type	Label	Description
id	string

GetPromptsRequest

Field	Type	Label	Description
page_token	int32
page_size	int32
target	string

PromptPage

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

ProtoPrompt

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

UpdatePromptRequest

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

Top

feedback-fusion-v1/resource.proto

ProtoResource

Field	Type	Label	Description
unknown	google.protobuf.Empty
target	ProtoTarget
prompt	ProtoPrompt
field	ProtoField

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)