Protocol Documentation

album.proto
enums.proto
- EGenderType
memory.proto
photo.proto
- MPhoto
tag.proto
- MTag
time_line.proto
- MTimeline
- STimelineService
user.proto
wish_board.proto
wish_card.proto
wish_category.proto
Scalar Value Types

album.proto

Top

Album

アルバム情報

Field	Type	Label	Description
album_id	int64		アルバムを特定するためのID
title	string		アルバムのタイトル
memories	proto_memory.Memories		アルバムに保存されている思い出一覧（配列）

Albums

アルバム一覧（配列）

Field	Type	Label	Description
albums	Album	repeated	アルバム一覧（配列）

CreateAlbumRequest

アルバム作成リクエスト

Field	Type	Label	Description
title	string		アルバム名 [required, max=200]

DeleteAlbumRequest

アルバム削除用リクエスト

Field	Type	Label	Description
album_id	int64		削除したいアルバムのID [required]

GetAlbumRequest

アルバム1件取得用リクエスト

Field	Type	Label	Description
album_id	int64		アルバムを特定するためのID [required]

GetMyAlbumsRequest

アルバム一覧（ID, title)取得用リクエスト

Field	Type	Label	Description
album_id	int64		取得開始位置を知らせるためのアルバムID [required]
limit	int64		最大取得件数 [default=1, max=20]

UpdateAlbumTitleRequest

アルバムタイトル変更用リクエスト

Field	Type	Label	Description
album_id	int64		変更したいアルバムのID [required]
title	string		変更したいアルバムタイトル [required, max=200]

AlbumService

Method Name	Request Type	Response Type	Description
CreateAlbum	CreateAlbumRequest	Album	アルバムの新規作成
GetAlbum	GetAlbumRequest	Album	IDをもとにアルバム1件を取得
GetMyAlbums	GetMyAlbumsRequest	Albums	アルバム一覧情報の取得
UpdateAlbumTitle	UpdateAlbumTitleRequest	Album	アルバムタイトルの変更
DeleteAlbum	DeleteAlbumRequest	.google.protobuf.Empty	アルバムの削除

enums.proto

Top

GenderType

性別タイプ

Name	Number	Description
UNKNOWN	0	不明・その他
MAN	1	男性
WOMAN	2	女性

memory.proto

Top

AddMemoryTagsRequest

思い出にタグを追加するためのリクエスト

Field	Type	Label	Description
memory_id	int64		タグを追加する思い出のID [required]
tag_names	string	repeated	追加したいタグの名前一覧（配列） [required, max_len=20]

CreateMemoryPhotosRequest

思い出に新規画像を追加するためのリクエスト

Field	Type	Label	Description
memory_id	int64		画像を追加する思い出のID [required]
photo_file	bytes	repeated	アップロードしたい画像ファイル(配列) [required, max_len=5]

CreateMemoryRequest

思い出新規作成リクエスト

Field	Type	Label	Description
album_id	int64		投稿した思い出を保存するアルバムのID [required]
activity	string		やったこと [required, max=50]
date	int64		日付(UNIX) [required]
description	string		思い出の説明
place	string		場所 [required, max=200]
photos	proto_photo.Photo	repeated	アップロードしたい画像一覧（配列）
tags	proto_tag.Tag	repeated	タグ一覧（配列）

DeleteMemoryPhotosRequest

思い出に紐づく画像のうちから指定したものを削除するためのリクエスト

Field	Type	Label	Description
memory_id	int64		画像を削除する思い出のID [required]
photo_ids	int64	repeated	削除したい画像のID一覧（配列） [required]

DeleteMemoryRequest

思い出削除リクエスト

Field	Type	Label	Description
memory_id	int64		削除する思い出のID [required]

DeleteMemoryTagsRequest

思い出のタグを削除するためのリクエスト

Field	Type	Label	Description
memory_id	int64		タグを削除する思い出のID [required]
tag_ids	int64	repeated	削除したいタグのID一覧（配列） [required]

GetMemoryRequest

思い出情報取得用リクエスト

Field	Type	Label	Description
memory_id	int64		思い出1件を特定するための思い出ID [required]

GetUserMemoriesRequest

ユーザーに紐づく思い出一覧取得用リクエスト

Field	Type	Label	Description
user_name	string		ユーザー名 [required, max=20]

Memories

思い出一覧情報

Field	Type	Label	Description
memory_count	MemoryCount		思い出カウント情報
memories	Memory	repeated	思い出一覧（配列）

Memory

思い出詳細情報

Field	Type	Label	Description
memory_id	int64		思い出ID
activity	string		やったこと
date	int64		日付(UNIX)
description	string		思い出の説明
place	string		場所
author	proto_user.User		作成者
photos	proto_photo.Photo	repeated	投稿されている画像一覧（配列）
tags	proto_tag.Tag	repeated	タグ一覧（配列）

MemoryCount

思い出のカウント情報

Field	Type	Label	Description
memories_count	int64		過去に投稿した思い出の数
published_count	int64		公開中の思い出の数

UpdateMemoryRequest

思い出の基本情報更新用リクエスト

Field	Type	Label	Description
memory_id	int64		更新する思い出のID [required]
activity	string		やったこと [required] ← ユーザー入力がない場合は現在の値を埋め込むこと
date	int64		日付(UNIX) [required] ← ユーザー入力がない場合は現在の値を埋め込むこと
description	string		思い出の説明 ← ユーザー入力がない場合は現在の値を埋め込むこと
place	string		場所 [required, max=200] ← ユーザー入力がない場合は現在の値を埋め込むこと

MemoryService

Method Name	Request Type	Response Type	Description
GetMemory	GetMemoryRequest	Memory	IDをもとに思い出1件を取得
GetUserMemories	GetUserMemoriesRequest	Memories	ユーザーが過去に投稿した思い出一覧を取得
CreateMemory	CreateMemoryRequest	Memory	思い出の新規作成
DeleteMemory	DeleteMemoryRequest	.google.protobuf.Empty	思い出自体の削除
UpdateMemory	UpdateMemoryRequest	Memory	思い出の基本情報を更新
UploadMemoryPhotos	CreateMemoryPhotosRequest	Memory	思い出に新規写真をアップロードする
DeleteMemoryPhotos	DeleteMemoryPhotosRequest	Memory	思い出の写真情報から指定した画像一覧を削除
AddMemoryTags	AddMemoryTagsRequest	Memory	思い出のタグを新規追加
DeleteMemoryTags	DeleteMemoryTagsRequest	Memory	思い出のタグを削除

photo.proto

Top

Photo

Field	Type	Label	Description
photo_id	int64		画像のID
photo_url	string		画像のURL

tag.proto

Top

Tag

Field	Type	Label	Description
tag_id	int64		タグID
tag_name	string		タグ名

time_line.proto

Top

Timeline

TODO: タイムライン情報(仮)

Field	Type	Label	Description
memories	proto_memory.Memory	repeated	タイムラインに表示する思い出一覧

TimelineService

Method Name	Request Type	Response Type	Description
GetTimeline	.google.protobuf.Empty	Timeline	タイムライン情報の取得

user.proto

Top

CreateUserRequest

新規ユーザ作成リクエスト

Field	Type	Label	Description
name	string		表示名 [required, max=50]
user_name	string		ユーザ名 [required, max=20]
thumbnail	bytes		アイコン画像ファイル
bio	string		ひとこと [max=100]
gender	proto_enums.GenderType		性別（1: man, 2: woman, 3: unknown） [required]
phone	string		電話番号 [max=15]
place	string		現在地的な。Twitterの真似 [max=30]
birth	int64		生年月日(UNIX)

GetUserRequest

ユーザー情報取得リクエスト（ユーザーを特定するためのID情報）

Field	Type	Label	Description
user_name	string		ユーザー名 [required, max=20]

UpdateUserProfileRequest

ユーザー情報更新リクエスト

Field	Type	Label	Description
user_id	int64		更新したいユーザーのID [required]
name	string		表示名 [required, max=50] ← ユーザー入力がない場合は現在の値を埋め込むこと
user_name	string		ユーザ名 [required, max=20, 他ユーザーと重複していない] ←ユーザー入力がない場合は現在の値を埋め込むこと
thumbnail	bytes		アイコン画像
bio	string		ひとこと [max=100]
gender	proto_enums.GenderType		性別（1: man, 2: woman, 3: unknown） [required] ←ユーザー入力がない場合は現在の値を埋め込むこと
phone	string		電話番号 [max=15]
place	string		現在地的な。Twitterの真似 [max=30]
birth	int64		生年月日(UNIX)

User

ユーザ情報

Field	Type	Label	Description
user_id	int64		ユーザーID
name	string		表示名
user_name	string		ユーザ名
thumbnail	string		アイコンのURL
bio	string		ひとこと
gender	proto_enums.GenderType		性別（0: unknown, 1: man, 2: woman）
place	string		現在地的な。Twitterの真似
birth	int64		生年月日(UNIX)

UserService

Method Name	Request Type	Response Type	Description
CreateUser	CreateUserRequest	User	新規ユーザ作成
GetMyProfile	.google.protobuf.Empty	User	ユーザー情報取得（マイページ）
GetUserProfile	GetUserRequest	User	ユーザー情報取得（他の人のページ）
UpdateUserProfile	UpdateUserProfileRequest	User	ユーザー情報更新

wish_board.proto

Top

CreateWishBoardRequest

やりたいことボード新規作成リクエスト

Field	Type	Label	Description
title	string		やりたいことボード名 [required, max=30]
background_image	bytes		新しい背景画像ファイル [空の場合はサーバー側でデフォルトの画像をセット]

DeleteWishBoardRequest

やりたいことボード削除用リクエスト

Field	Type	Label	Description
wish_board_id	int64		削除したいやりたいことボードのID [required]

GetWishBoardListRequest

やりたいことボード（ID, titleのみ）の配列を取得するためのリクエスト

Field	Type	Label	Description
wish_board_id	int64		取得開始位置を知らせるためのやりたいことボードID [required]
limit	int64		最大取得件数 [default=1, max=20]

GetWishBoardRequest

IDをもとにやりたいことボードを1件取得するためのリクエスト

Field	Type	Label	Description
wish_board_id	int64		やりたいことボードを特定するためのID [required]

UpdateWishBoardBackgroundImageRequest

やりたいことボード背景画像変更リクエスト

Field	Type	Label	Description
wish_board_id	int64		やりたいことボードID [required]
background_image	bytes		新しい背景画像ファイル [required]

UpdateWishBoardNameRequest

やりたいことボード名変更リクエスト

Field	Type	Label	Description
wish_board_id	int64		やりたいことボードID [required]
title	string		新しいやりたいことボード名 [required, max=30]

UpdateWishCategoryAndCardPositionRequest

やりたいことカテゴリーの並び替えリクエスト

Field	Type	Label	Description
wish_board_id	int64		やりたいことボードID [required]
position	WishCategoryAndCardPosition	repeated	やりたいことカテゴリーの並び順（IDの配列） [required]

WishBoard

やりたいことボード情報

Field	Type	Label	Description
wish_board_id	int64		やりたいことボードを特定するためのID
title	string		やりたいことボードタイトル
wish_categories	proto_wishcategory.WishCategory	repeated	やりたいことカテゴリー一覧（配列）
authors	proto_user.User	repeated	編集権限を持っているユーザー一覧（配列）
invite_url	string		招待リンク
background_image_url	string		背景画像URL

WishBoardList

やりたいことボードの一覧（配列）

Field	Type	Label	Description
wish_board	WishBoard	repeated	やりたいことボード一覧（配列）

WishCategoryAndCardPosition

やりたいことカテゴリーとカードのポジションを表したもの

Field	Type	Label	Description
wish_category_id	int64		やりたいことカテゴリーID [max_len=1]
wish_card_ids	int64	repeated	やりたいことカテゴリーに所属するカードのID一覧（並び順を表す配列）

WishBoardService

Method Name	Request Type	Response Type	Description
CreateWishBoard	CreateWishBoardRequest	WishBoard	やりたいことボードの新規作成
GetWishBoardList	GetWishBoardListRequest	WishBoardList	やりたいことボード一覧取得
GetWishBoard	GetWishBoardRequest	WishBoard stream	やりたいことボード単体取得
UpdateWishBoardName	UpdateWishBoardNameRequest	.google.protobuf.Empty	やりたいことボード名更新
UpdateWishBoardBackgroundImage	UpdateWishBoardBackgroundImageRequest	.google.protobuf.Empty	やりたいことボードの背景画像更新
UpdateWishCategoryPriority	UpdateWishCategoryAndCardPositionRequest	.google.protobuf.Empty	やりたいことカテゴリー、カードの並び順更新
DeleteWishBoard	DeleteWishBoardRequest	.google.protobuf.Empty	やりたいことボード自体の削除

wish_card.proto

Top

AddWishCardTagsRequest

やりたいことカードに新規タグの追加リクエスト

Field	Type	Label	Description
wish_card_id	int64		タグを追加するやりたいことカードのID [required]
tag_names	string	repeated	追加したいタグの名前一覧（配列） [required, max=20]

CreateWishCardRequest

やりたいことカード新規作成リクエスト

Field	Type	Label	Description
wish_category_id	int64		やりたいことカテゴリーID [required]
activity	string		何をしたいのか [required, max=50]
description	string		やりたいことの説明 [max=100]
date	int64		いつやりたいか（UNIX） [過去の日付ではない]
place	string		どこでそれをしたいのか [required, max=200]

DeleteWishCardRequest

やりたいことカード削除用リクエスト

Field	Type	Label	Description
wish_card_id	int64		削除したいやりたいことカードのID [required]

DeleteWishCardTagsRequest

やりたいことカードからタグを削除

Field	Type	Label	Description
wish_card_id	int64		タグを削除するやりたいことカードのID [required]
tag_ids	int64	repeated	削除したいタグのID一覧（配列） [required]

UpdateWishCardActivityRequest

やりたいことカードのアクティビティ更新リクエスト

Field	Type	Label	Description
wish_card_id	int64		カードのID [required]
activity	string		アクティビティ名 [required, max=50]

UpdateWishCardDateRequest

やりたいことカードの日付変更リクエスト

Field	Type	Label	Description
wish_card_id	int64		カードのID [required]
date	int64		日付 [required, 過去の日付ではない]

UpdateWishCardDescriptionRequest

やりたいことカードの説明更新リクエスト

Field	Type	Label	Description
wish_card_id	int64		カードのID [required]
description	string		説明 [required, max=100]

UpdateWishCardPlaceRequest

やりたいことカードの場所変更リクエスト

Field	Type	Label	Description
wish_card_id	int64		カードのID [required]
place	string		場所 [required, max=200]

WishCard

やりたいことカード情報

Field	Type	Label	Description
wish_card_id	int64		wish_cardを特定するためのID
activity	string		何をしたいのか
description	string		やりたいことの説明
date	int64		いつやりたいか（UNIX）
done_at	int64		完了日時
place	string		どこでそれをしたいのか
tags	proto_tag.Tag	repeated	タグ一覧（配列）

WishCardService

Method Name	Request Type	Response Type	Description
CreateWishCard	CreateWishCardRequest	.google.protobuf.Empty	やりたいことカードの新規作成
UpdateWishCardActivity	UpdateWishCardActivityRequest	.google.protobuf.Empty	やりたいことカード(アクティビティ)の更新
UpdateWishCardDescription	UpdateWishCardDescriptionRequest	.google.protobuf.Empty	やりたいことカード(ディスクリプション)の更新
UpdateWishCardDate	UpdateWishCardDateRequest	.google.protobuf.Empty	やりたいことカード(日付)の更新
UpdateWishCardPlace	UpdateWishCardPlaceRequest	.google.protobuf.Empty	やりたいことカード(場所)の更新
AddWishCardTags	AddWishCardTagsRequest	.google.protobuf.Empty	やりたいことカードのタグを新規追加
DeleteWishCardTags	DeleteWishCardTagsRequest	.google.protobuf.Empty	やりたいことカードのタグを削除
DeleteWishCard	DeleteWishCardRequest	.google.protobuf.Empty	やりたいことカードの削除

wish_category.proto

Top

CreateWishCategoryRequest

やりたいことカテゴリー新規作成リクエスト

Field	Type	Label	Description
wish_board_id	int64		やりたいことボードID [required]
title	string		やりたいことカテゴリー名 [required, max=30]

DeleteWishCategoryRequest

やりたいことカテゴリー削除用リクエスト

Field	Type	Label	Description
wish_category_id	int64		削除したいやりたいことカテゴリーのID [required]

UpdateWishCategoryTitleRequest

やりたいことカテゴリータイトル更新リクエスト

Field	Type	Label	Description
wish_category_id	int64		やりたいことカテゴリーID [required]
title	string		新規やりたいことカテゴリータイトル [required, max=30]

WishCategory

やりたいことカテゴリー情報

Field	Type	Label	Description
wish_category_id	int64		やりたいことカテゴリーを特定するためのID
title	string		やりたいことカテゴリー名
wish_cards	proto_wishcard.WishCard	repeated	カテゴリー内のやりたいことカード一覧（配列）

WishCategoryService

Method Name	Request Type	Response Type	Description
CreateWishCategory	CreateWishCategoryRequest	.google.protobuf.Empty	やりたいことカテゴリーの新規作成
UpdateWishCategoryTitle	UpdateWishCategoryTitleRequest	.google.protobuf.Empty	やりたいことカテゴリータイトル更新
DeleteWishCategory	DeleteWishCategoryRequest	.google.protobuf.Empty	やりたいことカテゴリーの削除

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)