Protocol Documentation

Table of Contents

wedding/kanshasai/v1/quiz.proto

Top

CreateQuizRequest

クイズ作成リクエスト

FieldTypeLabelDescription
body string

クイズ問題文

quiz_type QuizType

クイズ種別

choice_texts string repeated

クイズ選択肢

correct_answer string

クイズ正解データ

event_id string

イベントID

CreateQuizResponse

クイズ作成レスポンス

FieldTypeLabelDescription
quiz_id string

クイズID

body string

クイズ問題文

quiz_type QuizType

クイズ種別

choices CreateQuizResponse.Choice repeated

クイズ選択肢

correct_answer string

クイズ正解データ

event_id string

イベントID

CreateQuizResponse.Choice

選択肢オブジェクト

FieldTypeLabelDescription
choice_id string

選択肢ID

body string

選択肢Body

DeleteQuizRequest

クイズ削除リクエスト

FieldTypeLabelDescription
quiz_id string

クイズID

DeleteQuizResponse

クイズ削除レスポンス

Empty

ListQuizzesRequest

クイズ一覧リクエスト

Empty

ListQuizzesResponse

クイズ一覧レスポンス

FieldTypeLabelDescription
quizzes ListQuizzesResponse.Quiz repeated

クイズの配列

ListQuizzesResponse.Choice

選択肢オブジェクト

FieldTypeLabelDescription
choice_id string

選択肢ID

body string

選択肢Body

ListQuizzesResponse.Quiz

クイズオブジェクト

FieldTypeLabelDescription
quiz_id string

クイズID

body string

クイズ問題文

quiz_type QuizType

クイズ種別

choices ListQuizzesResponse.Choice repeated

クイズ選択肢

correct_answer string

クイズ正解データ

UpdateQuizRequest

クイズ更新リクエスト

FieldTypeLabelDescription
quiz_id string

クイズID

body string

クイズ問題文

quiz_type QuizType

クイズ種別

choice_texts string repeated

クイズ選択肢(一部更新に対応しないので、全て削除して再度作成する)

correct_answer string

クイズ正解データ

UpdateQuizResponse

クイズ更新レスポンス

FieldTypeLabelDescription
quiz_id string

クイズID

body string

クイズ問題文

quiz_type QuizType

クイズ種別

choices UpdateQuizResponse.Choice repeated

クイズ選択肢

correct_answer string

クイズ正解データ

UpdateQuizResponse.Choice

選択肢オブジェクト

FieldTypeLabelDescription
choice_id string

選択肢ID

body string

選択肢Body

QuizService

クイズに対する基本的な操作を提供するサービス

Method NameRequest TypeResponse TypeDescription
CreateQuiz CreateQuizRequest CreateQuizResponse

クイズ作成

DeleteQuiz DeleteQuizRequest DeleteQuizResponse

クイズ削除

UpdateQuiz UpdateQuizRequest UpdateQuizResponse

クイズ更新

ListQuizzes ListQuizzesRequest ListQuizzesResponse

クイズ一覧取得API

wedding/kanshasai/v1/session.proto

Top

BackIntroductionRequest

イントロダクション前へリクエスト

FieldTypeLabelDescription
session_id string

セッションID

BackIntroductionResponse

イントロダクション前へレスポンス

Empty

CancelCurrentQuizRequest

クイズ中止リクエスト

FieldTypeLabelDescription
session_id string

セッションID

CancelCurrentQuizResponse

クイズ中止レスポンス

Empty

CreateSessionRequest

セッション作成リクエスト

FieldTypeLabelDescription
name string

セッション名

event_id string

イベントID

CreateSessionResponse

セッション作成レスポンス

FieldTypeLabelDescription
session_id string

セッションID

name string

セッション名

event_id string

イベントID

FinishIntroductionRequest

イントロダクション完了リクエスト

FieldTypeLabelDescription
session_id string

セッションID

FinishIntroductionResponse

イントロダクション完了レスポンス

Empty

FinishQuizRequest

クイズ終了リクエスト

FieldTypeLabelDescription
session_id string

セッションID

FinishQuizResponse

クイズ終了レスポンス

Empty

FinishSessionRequest

セッション終了リクエスト

FieldTypeLabelDescription
session_id string

セッションID

FinishSessionResponse

セッション終了レスポンス

Empty

GetSessionStatusRequest

セッション情報取得リクエスト

FieldTypeLabelDescription
session_id string

セッションID

GetSessionStatusResponse

セッション情報取得レスポンス

FieldTypeLabelDescription
simple_session_state SimpleSessionState

ゲームの進行状態

qr_code_image_url string

QRコードの画像URL

ListSessionQuizzesRequest

クイズ一覧リクエスト

FieldTypeLabelDescription
session_id string

セッションID

ListSessionQuizzesResponse

クイズ一覧レスポンス

FieldTypeLabelDescription
session_quizzes ListSessionQuizzesResponse.SessionQuiz repeated

クイズの配列

ListSessionQuizzesResponse.Choice

選択肢オブジェクト

FieldTypeLabelDescription
choice_id string

選択肢ID

body string

選択肢Body

ListSessionQuizzesResponse.SessionQuiz

完了フラグを持ったクイズオブジェクト

FieldTypeLabelDescription
quiz_id string

クイズID

body string

クイズ問題文

quiz_type QuizType

クイズ種別

choices ListSessionQuizzesResponse.Choice repeated

クイズ選択肢

is_completed bool

完了済フラグ

ListSessionsRequest

セッション一覧リクエスト

FieldTypeLabelDescription
event_id string

イベントID

include_finished bool

終了済みセッションも含めるか

ListSessionsResponse

セッション一覧レスポンス

FieldTypeLabelDescription
sessions ListSessionsResponse.Session repeated

セッションの配列

ListSessionsResponse.Session

セッションオブジェクト

FieldTypeLabelDescription
session_id string

セッションID

name string

セッション名

event_id string

イベントID

NextIntroductionRequest

イントロダクション次へリクエスト

FieldTypeLabelDescription
session_id string

セッションID

NextIntroductionResponse

イントロダクション次へレスポンス

Empty

SetCoverRequest

カバー表示リクエスト

FieldTypeLabelDescription
session_id string

セッションID

is_visible bool

カバー画面を表示するか

SetCoverResponse

カバー表示レスポンス

Empty

SetNextQuizRequest

クイズ選択リクエスト

FieldTypeLabelDescription
session_id string

セッションID

quiz_id string

クイズID

SetNextQuizResponse

クイズ選択レスポンス

Empty

SetQuizAnswerRequest

クイズ回答設定リクエスト

FieldTypeLabelDescription
session_id string

セッションID

correct_answer string

クイズ正解データ

quiz_id string

クイズID

SetQuizAnswerResponse

クイズ回答設定レスポンス

Empty

ShowBackSessionResultRankingRequest

前の結果画面表示リクエスト

FieldTypeLabelDescription
session_id string

セッションID

ShowBackSessionResultRankingResponse

前の結果画面ランキング表示レスポンス

Empty

ShowNextSessionResultRankingRequest

次の結果画面表示リクエスト

FieldTypeLabelDescription
session_id string

セッションID

ShowNextSessionResultRankingResponse

次の結果画面表示レスポンス

Empty

ShowProfileRequest

プロフィール表示リクエスト

FieldTypeLabelDescription
session_id string

セッションID

ShowProfileResponse

プロフィール表示レスポンス

Empty

ShowQuizRequest

クイズ表示リクエスト

FieldTypeLabelDescription
session_id string

セッションID

ShowQuizResponse

クイズ表示レスポンス

Empty

ShowQuizResultRequest

クイズ結果表示リクエスト

FieldTypeLabelDescription
session_id string

セッションID

quiz_result_type QuizResultType

表示したい結果表示画面の種類

ShowQuizResultResponse

クイズ結果表示レスポンス

Empty

ShowSessionResultRankingRequest

結果画面ランキング表示リクエスト

FieldTypeLabelDescription
session_id string

セッションID

result_ranking_type ResultRankingType

結果発表ランキング種別

start_position int32

開始位置

end_position int32

終了位置

pre_display_count int32

何個表示しておくか

display_count int32

何個表示するか

emphasize_positions int32 repeated

強調表示する位置の配列

ShowSessionResultRankingResponse

結果画面ランキング表示レスポンス

Empty

ShowSessionResultTitleRequest

結果画面タイトル表示リクエスト

FieldTypeLabelDescription
session_id string

セッションID

result_title_type ResultTitleType

結果画面種別

rank int32 optional

順位(RESULT_RANKING_TYPE_RANK系のみ)

ShowSessionResultTitleResponse

結果画面タイトル表示レスポンス

Empty

StartQuizRequest

クイズ開始リクエスト

FieldTypeLabelDescription
session_id string

セッションID

StartQuizResponse

クイズ開始レスポンス

Empty

StartSessionResultRequest

結果画面開始リクエスト

FieldTypeLabelDescription
session_id string

セッションID

result_type ResultType

結果画面種別

StartSessionResultResponse

結果画面開始レスポンス

Empty

SessionService

セッション(開始〜クイズ複数回〜終了までの1セット)に関連する操作を提供するサービス

基本的に司会が操作する機能を提供する

Method NameRequest TypeResponse TypeDescription
CreateSession CreateSessionRequest CreateSessionResponse

セッション作成

ListSessions ListSessionsRequest ListSessionsResponse

セッション一覧

ListSessionQuizzes ListSessionQuizzesRequest ListSessionQuizzesResponse

セッションに紐づいたクイズ一覧

NextIntroduction NextIntroductionRequest NextIntroductionResponse

イントロダクション次へ

BackIntroduction BackIntroductionRequest BackIntroductionResponse

イントロダクション前へ

ShowProfile ShowProfileRequest ShowProfileResponse

プロフィール表示

FinishIntroduction FinishIntroductionRequest FinishIntroductionResponse

イントロダクション完了

SetNextQuiz SetNextQuizRequest SetNextQuizResponse

クイズ選択

ShowQuiz ShowQuizRequest ShowQuizResponse

クイズ表示

StartQuiz StartQuizRequest StartQuizResponse

クイズ開始(カウントダウンスタート)

CancelCurrentQuiz CancelCurrentQuizRequest CancelCurrentQuizResponse

クイズ中止(このクイズに関連する情報を破棄)

SetQuizAnswer SetQuizAnswerRequest SetQuizAnswerResponse

クイズ回答設定

ShowQuizResult ShowQuizResultRequest ShowQuizResultResponse

クイズ結果表示

SetCover SetCoverRequest SetCoverResponse

カバー表示

StartSessionResult StartSessionResultRequest StartSessionResultResponse

結果発表開始

ShowSessionResultTitle ShowSessionResultTitleRequest ShowSessionResultTitleResponse

結果発表タイトル表示

ShowNextSessionResultRanking ShowNextSessionResultRankingRequest ShowNextSessionResultRankingResponse

次の結果発表表示

ShowBackSessionResultRanking ShowBackSessionResultRankingRequest ShowBackSessionResultRankingResponse

前の結果発表表示

ShowSessionResultRanking ShowSessionResultRankingRequest ShowSessionResultRankingResponse

結果発表ランキング表示

FinishQuiz FinishQuizRequest FinishQuizResponse

クイズ終了

FinishSession FinishSessionRequest FinishSessionResponse

セッション終了

GetSessionStatus GetSessionStatusRequest GetSessionStatusResponse

セッション情報取得

wedding/kanshasai/v1/screen.proto

Top

CloseQuizRequest

クイズ締め切りリクエスト

FieldTypeLabelDescription
session_id string

セッションID

CloseQuizResponse

クイズ締め切りレスポンス

Empty

SendMessageRequest

メッセージ送信リクエスト

FieldTypeLabelDescription
session_id string

セッションID

body string

メッセージ本文

level MessageLevel

メッセージレベル

SendMessageResponse

メッセージ送信レスポンス

Empty

ScreenService

スクリーンに関連する操作を提供するサービス

Method NameRequest TypeResponse TypeDescription
SendMessage SendMessageRequest SendMessageResponse

バックエンド/管理画面にメッセージ送信

CloseQuiz CloseQuizRequest CloseQuizResponse

クイズ締め切り

wedding/kanshasai/v1/participant.proto

Top

CreateParticipantRequest

参加者作成リクエスト

FieldTypeLabelDescription
session_id string

セッションID

name string

参加者名

image_id string optional

画像URL

participant_type ParticipantType

参加者種別

name_ruby string optional

参加者名ルビ

CreateParticipantResponse

参加者作成レスポンス

FieldTypeLabelDescription
participant_id string

参加者ID

session_id string

セッションID

name string

参加者名

image_url string

画像URL

participant_type ParticipantType

参加者種別

name_ruby string

参加者名ルビ

GetParticipantRequest

参加者取得リクエスト

FieldTypeLabelDescription
participant_id string

参加者ID

GetParticipantResponse

参加者取得レスポンス

FieldTypeLabelDescription
participant_id string

参加者ID

session_id string

セッションID

name string

参加者名

image_url string

画像URL

participant_type ParticipantType

参加者種別

name_ruby string

参加者名ルビ

ListParticipantsRequest

参加者一覧リクエスト

FieldTypeLabelDescription
session_id string

セッションID

participant_type ParticipantType optional

参加者種別(未指定で両方)

ListParticipantsResponse

参加者一覧レスポンス

FieldTypeLabelDescription
participants ListParticipantsResponse.Participant repeated

参加者の配列

ListParticipantsResponse.Participant

参加者オブジェクト

FieldTypeLabelDescription
participant_id string

参加者ID

session_id string

セッションID

name string

参加者名

image_url string

画像URL

participant_type ParticipantType

参加者種別

is_connected bool

接続済みかどうか

name_ruby string

参加者名ルビ

RegisterParticipantRequest

参加者登録リクエスト

FieldTypeLabelDescription
session_id string

セッションID

participant_id string

参加者ID TODO: アンケートを追加する場合ここ

RegisterParticipantResponse

参加者登録レスポンス

Empty

SetAnswerRequest

回答登録リクエスト

FieldTypeLabelDescription
participant_id string

参加者ID

quiz_id string

クイズID

answer string

クイズ正解データ

time float

回答までの時間

SetAnswerResponse

回答登録レスポンス

Empty

UpdateParticipantRequest

参加者更新リクエスト

FieldTypeLabelDescription
participant_id string

参加者ID

session_id string

セッションID

name string

参加者名

image_id string optional

画像URL

participant_type ParticipantType

参加者種別

name_ruby string optional

参加者名ルビ

UpdateParticipantResponse

参加者更新レスポンス

FieldTypeLabelDescription
participant_id string

参加者ID

session_id string

セッションID

name string

参加者名

image_url string

画像URL

participant_type ParticipantType

参加者種別

name_ruby string

参加者名ルビ

ParticipantService

参加者に関連する操作を提供するサービス

Method NameRequest TypeResponse TypeDescription
CreateParticipant CreateParticipantRequest CreateParticipantResponse

参加者作成(管理側用)

GetParticipant GetParticipantRequest GetParticipantResponse

参加者取得

UpdateParticipant UpdateParticipantRequest UpdateParticipantResponse

参加者更新(管理側用)

ListParticipants ListParticipantsRequest ListParticipantsResponse

参加者一覧

RegisterParticipant RegisterParticipantRequest RegisterParticipantResponse

参加者登録

SetAnswer SetAnswerRequest SetAnswerResponse

回答登録

wedding/kanshasai/v1/event.proto

Top

CreateEventRequest

イベント作成リクエスト

FieldTypeLabelDescription
event_name string

イベント名

CreateEventResponse

イベント作成レスポンス

FieldTypeLabelDescription
event_id string

イベントID

event_name string

イベント名

DeleteEventRequest

イベント削除リクエスト

FieldTypeLabelDescription
event_id string

イベントID

DeleteEventResponse

イベント削除レスポンス

Empty

ListEventsRequest

イベント一覧リクエスト

Empty

ListEventsResponse

イベント一覧レスポンス

FieldTypeLabelDescription
events ListEventsResponse.Event repeated

イベント一覧

ListEventsResponse.Event

イベントオブジェクト

FieldTypeLabelDescription
event_id string

イベントID

event_name string

イベント名

UpdateEventRequest

イベント作成リクエスト

FieldTypeLabelDescription
event_id string

イベントID

event_name string

イベント名

UpdateEventResponse

イベント作成レスポンス

FieldTypeLabelDescription
event_id string

イベントID

event_name string

イベント名

EventService

イベントに関連する操作を提供するサービス

Method NameRequest TypeResponse TypeDescription
CreateEvent CreateEventRequest CreateEventResponse

イベント作成

UpdateEvent UpdateEventRequest UpdateEventResponse

イベント更新

DeleteEvent DeleteEventRequest DeleteEventResponse

イベント削除

ListEvents ListEventsRequest ListEventsResponse

イベント一覧

wedding/kanshasai/v1/common.proto

Top

GeneratePresignedUrlRequest

Presigned URL生成リクエスト

Empty

GeneratePresignedUrlResponse

Presigned URL生成レスポンス

FieldTypeLabelDescription
presigned_url string

Presigned URL

file_id string

File Id

EventType

イベント種別

NameNumberDescription
EVENT_TYPE_UNSPECIFIED 0

未定義

EVENT_TYPE_INTRODUCTION 10

イントロダクション表示イベント

EVENT_TYPE_SHOW_PROFILE 11

プロフィール表示イベント

EVENT_TYPE_PRE_QUIZ 20

クイズ情報イベント(クイズや選択肢画像などをプリロードするためのイベント)

EVENT_TYPE_SHOW_QUIZ 21

クイズ表示イベント(PreQuizで取得できていなくても動かせるよう全データを載せる)

EVENT_TYPE_START_QUIZ 22

クイズ回答開始イベント

EVENT_TYPE_QUIZ_TIME_UP 23

締め切りイベント

EVENT_TYPE_QUIZ_ANSWER_LIST 24

クイズ回答数イベント

EVENT_TYPE_QUIZ_RESULT 25

クイズ結果イベント

EVENT_TYPE_QUIZ_SPEED_RANKING 26

早押しランキングイベント

EVENT_TYPE_UPDATE_PARTICIPANT 27

参加者情報更新イベント

EVENT_TYPE_UPDATE_ANSWER 28

回答情報更新イベント

EVENT_TYPE_CANCEL_QUIZ 29

クイズキャンセルイベント

EVENT_TYPE_SESSION_INTERIM_RESULT 30

中間結果表示イベント

EVENT_TYPE_SESSION_FINAL_RESULT 31

最終結果表示イベント

EVENT_TYPE_WINNER 32

勝者イベント(参加者用)

EVENT_TYPE_FINISH 40

終了イベント

EVENT_TYPE_RESULT_TITLE 41

結果発表タイトルイベント

EVENT_TYPE_RESULT_INFO 42

結果発表情報イベント(STREAM_TYPE_MANAGER)

EVENT_TYPE_RESULT_RANKING_TITLE 43

結果発表ランキングタイトルイベント

EVENT_TYPE_RESULT_RANKING 44

結果発表ランキング表示

EVENT_TYPE_RESULT_PRESENT 45

結果発表プレゼント表示

EVENT_TYPE_MESSAGE 50

メッセージイベント

EVENT_TYPE_COVER 98

カバーイベント

EVENT_TYPE_CURRENT_STATE 99

現在状態イベント

EVENT_TYPE_FULL_CURRENT_STATE 100

現在状態イベント(STREAM_TYPE_MANAGER/接続時)

MessageLevel

メッセージレベル種別

NameNumberDescription
MESSAGE_LEVEL_UNSPECIFIED 0

未定義

MESSAGE_LEVEL_NOTICE 1

NOTICEレベル

MESSAGE_LEVEL_WARN 2

WARNレベル

MESSAGE_LEVEL_ERROR 3

ERRORレベル

ParticipantType

参加者種別

NameNumberDescription
PARTICIPANT_TYPE_UNSPECIFIED 0

未定義

PARTICIPANT_TYPE_GROOM 1

新郎側

PARTICIPANT_TYPE_BRIDE 2

新婦側

QuizResultType

クイズ結果種別

NameNumberDescription
QUIZ_RESULT_TYPE_UNSPECIFIED 0

未定義

QUIZ_RESULT_TYPE_VOTE_LIST 1

投票数

QUIZ_RESULT_TYPE_RESULT 2

結果

QUIZ_RESULT_TYPE_FASTEST_RANKING 3

早押しランキング

QuizType

クイズ種別

NameNumberDescription
QUIZ_TYPE_UNSPECIFIED 0

未定義

QUIZ_TYPE_FOUR_CHOICES_QUIZ 1

四択クイズ

QUIZ_TYPE_SORT_IMAGE_QUIZ 2

画像並び替えクイズ

QUIZ_TYPE_REALTIME_FOUR_CHOICE_QUIZ 3

リアルタイムクイズ

ResultPresentType

結果発表プレゼント種別

NameNumberDescription
RESULT_PRESENT_TYPE_UNSPECIFIED 0

未定義

RESULT_PRESENT_TYPE_BOOBY 1

ブービー賞

RESULT_PRESENT_TYPE_JUST 2

ぴたり賞

RESULT_PRESENT_TYPE_RANK 3

順位

RESULT_PRESENT_TYPE_4_7 4

4位7位

ResultRankingType

結果発表ランキング種別

NameNumberDescription
RESULT_RANKING_TYPE_UNSPECIFIED 0

未定義

RESULT_RANKING_TYPE_BOOBY 1

ブービー賞

RESULT_RANKING_TYPE_JUST 2

ぴたり賞

RESULT_RANKING_TYPE_RANK 3

順位

ResultTitleType

結果発表タイトル種別

NameNumberDescription
RESULT_TITLE_TYPE_UNSPECIFIED 0

未定義

RESULT_TITLE_TYPE_BOOBY 1

ブービー賞

RESULT_TITLE_TYPE_JUST 2

ぴたり賞

RESULT_TITLE_TYPE_RANK 3

順位

RESULT_TITLE_TYPE_RANK_DUMMY_1 4

順位表示用ダミー1(と、言いたいところですが!)

RESULT_TITLE_TYPE_RANK_DUMMY_2 5

順位表示用ダミー2(と思いきや!!)

RESULT_TITLE_TYPE_RANK_ACTUAL 6

順位(本気の)

ResultType

結果発表タイトル種別

NameNumberDescription
RESULT_TYPE_UNSPECIFIED 0

未定義

RESULT_TYPE_INTERIM 1

中間結果発表

RESULT_TYPE_FINAL 2

最終結果発表

SimpleSessionState

ゲームの状態を表すステート

NameNumberDescription
SIMPLE_SESSION_STATE_UNSPECIFIED 0

未定義

SIMPLE_SESSION_STATE_BEFORE_START 1

開始前状態

SIMPLE_SESSION_STATE_DURING_THE_GAME 2

ゲーム中状態

SIMPLE_SESSION_STATE_FINISHED 3

終了済状態

StreamType

ストリーム種別

NameNumberDescription
STREAM_TYPE_UNSPECIFIED 0

未定義

STREAM_TYPE_SCREEN 1

スクリーン

STREAM_TYPE_PARTICIPANT 2

参加者

STREAM_TYPE_MANAGER 3

司会者

CommonService

汎用的な機能を提供するサービス

Method NameRequest TypeResponse TypeDescription
GeneratePresignedUrl GeneratePresignedUrlRequest GeneratePresignedUrlResponse

アップロードに用いるPresigned URLを生成する

wedding/kanshasai/v1/stream.proto

Top

StreamEventRequest

イベントストリームリクエスト

FieldTypeLabelDescription
session_id string

セッションID

participant_id string

参加者ID

type StreamType

ストリーム種別

StreamEventResponse

イベントストリームレスポンス

FieldTypeLabelDescription
event_type EventType

イベント種別

correct_answer_count int32

正答数(StreamType = STREAM_TYPE_PARTICIPANTの際のみ)

participants StreamEventResponse.Participant repeated

参加者の配列(UPDATE_PARTICIPANT)

answers StreamEventResponse.Answer repeated

回答情報(UPDATE_ANSWER)

introduction_event StreamEventResponse.IntroductionEvent

イントロダクション表示イベントBody

quiz StreamEventResponse.Quiz

クイズ(PRE_QUIZ / SHOW_QUIZ / START_QUIZ / QUIZ_TIME_UP / QUIZ_ANSWER_LIST / QUIZ_RESULT)

speed_ranking StreamEventResponse.SpeedRanking

早押しランキング(QUIZ_SPEED_RANKING)

message StreamEventResponse.Message

メッセージ(MESSAGE)

cover StreamEventResponse.Cover

カバー(COVER)

session_state StreamEventResponse.SessionState

現在状態(CURRENT_STATE)

result_title StreamEventResponse.ResultTitle

結果発表タイトル(RESULT_TITLE)

result_info StreamEventResponse.ResultInfo

結果画面情報(RESULT_INFO)

result_ranking_title StreamEventResponse.ResultRankingTitle

結果発表ランキングタイトル(RESULT_RANKING_TITLE)

result_ranking StreamEventResponse.ResultRanking

結果発表ランキング(RESULT_RANKING)

result_present StreamEventResponse.ResultPresent

結果発表プレゼント(RESULT_PRESENT)

profile StreamEventResponse.Profile

プロフィール(SHOW_PROFILE)

StreamEventResponse.Answer

回答情報オブジェクト

FieldTypeLabelDescription
participant_name string

参加者名

answer_body string

回答内容

is_correct_choice bool

正解フラグ

participant_image_url string

参加者画像URL

time float

回答時間

participant_name_ruby string

参加者名ルビ

StreamEventResponse.Cover

カバー

FieldTypeLabelDescription
is_visible bool

カバーを表示するか

StreamEventResponse.IntroductionEvent

イントロダクション

FieldTypeLabelDescription
introduction_id int32

イントロダクションID

is_first bool

最初のイントロダクションフラグ

is_last bool

最後のイントロダクションフラグ

qr_code_image_url string

QRコードの画像URL

StreamEventResponse.Message

メッセージ

FieldTypeLabelDescription
body string

メッセージ本文

level MessageLevel

メッセージレベル

StreamEventResponse.Participant

参加者オブジェクト

FieldTypeLabelDescription
participant_id string

参加者ID

session_id string

セッションID

name string

参加者名

image_url string

画像URL

participant_type ParticipantType

参加者種別

is_connected bool

接続済みかどうか

is_answered bool

回答済みかどうか

name_ruby string

参加者名ルビ

StreamEventResponse.Profile

プロフィールオブジェクト

FieldTypeLabelDescription
participant_name string

参加者名

participant_image_url string

参加者画像URL

participant_name_ruby string

参加者名ルビ

StreamEventResponse.Quiz

クイズ情報

FieldTypeLabelDescription
quiz_id string

クイズID

body string

クイズ問題文

quiz_type QuizType

クイズ種別

choices StreamEventResponse.Quiz.Choice repeated

クイズ選択肢の配列

quiz_number int32

何問目

elapsed_time float optional

経過時間(QUIZ_PLAYINGかつSTREAM_TYPE_PARTICIPANTのみ)

StreamEventResponse.Quiz.Choice

クイズ選択肢オブジェクト

FieldTypeLabelDescription
choice_id string

選択肢ID

body string

選択肢Body

count int32 optional

件数(QUIZ_ANSWER_LIST / QUIZ_RESULTのみ)

is_correct_choice bool optional

正解フラグ(QUIZ_RESULTのみ)

is_selected_choice bool optional

選択フラグ(QUIZ_RESULTかつSTREAM_TYPE_PARTICIPANTのみ)

StreamEventResponse.ResultInfo

結果発表情報オブジェクト

FieldTypeLabelDescription
participant_session_scores StreamEventResponse.ResultInfo.ParticipantSessionScore repeated

参加者のスコアの配列

result_ranking_type ResultRankingType

結果発表ランキング種別

StreamEventResponse.ResultInfo.ParticipantSessionScore

参加者のスコア

FieldTypeLabelDescription
rank int32

順位

participant_name string

参加者名

score int32

スコア

time float

秒数

participant_name_ruby string

参加者名ルビ

StreamEventResponse.ResultPresent

結果発表プレゼントオブジェクト

FieldTypeLabelDescription
rank int32

順位

result_present_type ResultPresentType

結果発表ランキング種別

StreamEventResponse.ResultRanking

結果発表ランキングオブジェクト

FieldTypeLabelDescription
participant_session_scores StreamEventResponse.ResultRanking.ParticipantSessionScore repeated

参加者のスコアの配列

pre_display_count int32

何個表示しておくか

display_count int32

何個表示するか

result_ranking_type ResultRankingType

結果発表ランキング種別

has_next_page bool

次のページがあるかどうか

StreamEventResponse.ResultRanking.ParticipantSessionScore

参加者のスコア

FieldTypeLabelDescription
rank int32

順位

participant_name string

参加者名

score int32

スコア

time float

秒数

is_emphasis bool

強調フラグ

is_hidden bool

隠しフラグ

participant_name_ruby string

参加者名ルビ

StreamEventResponse.ResultRankingTitle

結果発表ランキングタイトルオブジェクト

FieldTypeLabelDescription
result_title_type ResultTitleType

結果発表ランキングタイトル種別

rank int32

順位

actual_result_title_type ResultTitleType

実際の結果発表ランキングタイトル種別(ダミー時用)

StreamEventResponse.ResultTitle

結果発表タイトルオブジェクト

FieldTypeLabelDescription
result_type ResultType

結果発表種別

StreamEventResponse.SessionState

現在状態

FieldTypeLabelDescription
simple_session_state SimpleSessionState

ゲームの進行状態

session_state string

ゲームの進行状態(バックエンドで定義しているより詳細なステート)

StreamEventResponse.SpeedRanking

早押しランキングイベントBody

FieldTypeLabelDescription
participant_quiz_times StreamEventResponse.SpeedRanking.ParticipantQuizTime repeated

参加者の回答時間の配列

StreamEventResponse.SpeedRanking.ParticipantQuizTime

参加者のスコア

FieldTypeLabelDescription
participant_name string

参加者名

participant_image_url string

参加者画像URL

time float

タイム

rank int32

順位

participant_name_ruby string

参加者名ルビ

StreamScreenEventRequest

イベントストリームレスポンス

FieldTypeLabelDescription
session_id string

セッションID

StreamService

包括的なストリーム機能を提供するサービス

Method NameRequest TypeResponse TypeDescription
StreamEvent StreamEventRequest StreamEventResponse stream

スクリーン向けイベントストリーム

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
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)