Server API List

Achievement

• achievement/unlock (session*, achievements*, verifiers*) – アチーブメントをアンロック。verifiersはgame_secret, session_id, achievement_idを連結してSHA1したもの。複数指定の場合はカンマ区切り、verifiersも同じ順番のカンマ区切りで指定。
• achievement/unlocks (session*, user, game) – アンロック済みアチーブメントの一覧を取得（userが省略された場合にはプレイヤーが対象、gameが省略された場合はプレイ中のゲームが対象）

Agreement

• agreement/show (session*) – プラットフォーム上で過去に利用規約への同意が行われたかどうかをチェックする。行われていればagreement構造体を、行われてなければnullをかえす。
• agreement/create (session*) – プラットフォームに対して利用規約への同意を実行し、agreement構造体をかえす。

Assets

• asset/show (session*, assets*) – アセット取得のための一時URL（有効期限は5分）を発行する。

Developer

• developer/games (session*) – ログインしているゲームのデベロッパーが作成したゲーム一覧を取得する。

Device

• device/register (game_key*, udid*, verifier*, name, os, hardware, platform) – デバイス登録、更新、取得
• device/users (game_key*, udid*, verifier*) – デバイスに紐づいているユーザの一覧を取得する。ユーザの順序は最終スイッチ日時の新しい順で、現在のゲームでアクティブなユーザがlast_user_idで与えられる。
• device/create_user (game_key*, udid*, verifier*, username, fullname, email, password) – デバイスに紐づいた新規ユーザを作成し、アクティブにする。次回session/createを呼んだときにはこの新ユーザでログインされる。usernameに"Player*"あるいは"Guest*"という形式でワイルドカード指定すると、そこにユーザIDが埋め込まれたものが自動でセットされる。
• device/transfer (session*, udid*, verifier*) – デバイスの所有者をセッションオーナーに移転する
• device/register_push_token (session*, push_token*, is_debug) – APNsのPushトークンを登録

Facebook (deprecated)

• facebook/link (session*, session_key*, session_secret*) – FBConnectで取得したセッションを使ってFacebookのアカウントをリンクする
• facebook/unlink (session*) – Facebookのリンクを解除し、情報を全てクリアする
• facebook/friends (session*) – Facebook上でつながっている友人のIDと名前の一覧を取得する
• facebook/import_graph (session*) – Facebook上でつながっている友人のID一覧をインポートし、そのうちPankia上でリンク済みのユーザについてはPankia上でもフォローする
• facebook/verify (session*) – Facebookのリンクが有効か確認する

Game

• game/show (session* or game*) – ゲームの詳細情報を取得
• game/find_random (session*, limit) – ゲームを全体からランダムに取得
• game/revision (session*) – ゲームの各種マスターデータをクライアントへ同期するためのリビジョン情報を取得
• game/achievements (session*) – ゲームが用意しているアチーブメント一覧をバージョン情報つきで取得
• game/assets (session*) – ゲームで設定されているアセット一覧を取得
• game/categories (session*) – ゲームが用意しているカテゴリ一覧をバージョン情報つきで取得
• game/features (session*) – ゲームが設定しているフィーチャー一覧を取得
• game/grades (session*) – ゲームが設定しているグレードを取得（バージョンなし）
• game/items (session*) – ゲームが設定しているアイテム一覧をバージョン情報つきで取得
• game/leaderboards (session*) – ゲームが用意しているリーダーボード一覧をバージョン情報つきで取得
• game/lobbies (session*) – ゲームが用意しているロビー一覧をバージョン情報つきで取得
• game/merchandises (session*) – ゲームが設定している商品一覧をバージョン情報つきで取得
• game/versions (session*) – ゲームで設定されているバージョン一覧を取得

Invitation

• invitation/show (session*, filter) – all（デフォルト）,sent,receivedのいずれかのfilterを用いて招待状の一覧を取得
• invitation/post (session*, room*, users, group, text) – usersまたはgroup(=現状ではall_followeesのみサポート)に宛ててルームへの招待状を送信（usersでユーザを複数指定する場合にはカンマ区切り）
• invitation/delete (session*, invitations*) – 招待状を削除（複数指定可）
• invitation/rooms (session*) – 招待されたルームの一覧を取得

Item

• item/show (session*, items*) – アイテム情報を取得する。添付ファイルがある場合には、ファイル取得のための一時URL（有効期限は5分）を発行する。
• item/ownerships (session*) – 所有しているアイテムの一覧を取得する。Consumableの場合はquantity、Subscriptionの場合はexpires_atが付帯情報として得られる。
• item/acquire (session*, items*, dedup_counter*, verifier*, quantities) – アイテムを取得する
• item/consume (session*, items*, dedup_counter*, verifier*, quantities) – アイテムを消費する
• item/exchange (session*, items*, dedup_counter*, verifier*, quantities*) – アイテム所持数の増減をアトミックに実行する。quantitiesにマイナス値を指定したアイテムが消費対象となる。ただし、消費アイテムが足りなかったり獲得アイテムが上限を越える場合にはエラーになる。

Leaderboard

• leaderboard/scores (session*, leaderboard*, period, among, offset, limit, reverse) – 条件を指定してリーダーボード取得。periodは通常 “20101212”, “2010w40”, “201012”, “forever” のいずれか（デフォルトはforever）。among=friendsを指定するとfriendsの範囲内で、among=selfを指定すると自分のスコアだけに絞り込んでランキングを取得。
• leaderboard/rank (session*, leaderboards*, user, period, among) – 指定した複数のリーダーボードと期間（デフォルトはforever）におけるトータルプレイヤー数と指定ユーザ（デフォルトは自分自身）の順位を取得。その期間にプレイしてなければ最下位となり、is_ranked=falseをかえす。among=friendsを指定するとfriendsの範囲内での順位を取得。
• leaderboard/latests (session*, leaderboards*) – 指定した複数のリーダーボードにおけるlatestの値を取得。
• leaderboard/post (session*, leaderboard*, scores*, dedup_counter*, verifier*, delta) – ゲームスコアを登録。deltaにtrueかfalseを指定すればリーダーボードのdelta属性をオーバーライドして差分によるコミットか絶対値によるコミットかを指定できる。deltaはdeprecated。
• leaderboard/increment (session*, leaderboard*, scores*, dedup_counter*, verifier*) – ゲームスコアを現在値（forever）からの差分で登録。負数の場合には"-1"のようにマイナス記号をつけて投稿する。

Match

• match/start (session*, room*, lock) – 現在のルームメンバーでマッチを開始。すでに開始しているマッチがある場合にはまずmatch/finishを実行すること
• match/finish (session*, room*, users**, grade_points**, dedup_counter**, verifier**, unlock) – マッチを終了し、必要に応じてグレードポイントを更新する。usersとgrade_pointsはカンマ区切りの順序を一致させること
• match/find (session*, users*) – 指定したユーザが含まれるマッチを検索する（現在のところlimitは10件）

Purchase

• purchase/register (session*, receipt*, price*, locale*, dedup_counter*, verifier*) – In-App Purchaseで購入したレシートをサーバに登録してアイテムを取得する
• purchase/history (session*, offset, limit) – 購買履歴を取得する

Report

• report/track_funnel (session*, step*) – 事前に定義されたstepの完了を通知し、Funnel Analysis用のデータとして登録する。

Room

• room/show (session*, room*, which) – ルーム情報を取得（取得項目を指定、複数可）
• room/find (session*, lobby_id, offset, limit) – ルーム一覧を取得する
• room/create (session*, name, is_public, max_members, grade_range) – ルームを新規作成する。grade_rangeを"eq",“gte”,"lte"のいずれかにセットするとグレード制限あり。
• room/update (session*, name, is_public, max_members, grade_range) – ルームを更新する。grade_rangeを"eq",“gte”,"lte"のいずれかにセットするとグレード制限あり。
• room/delete (session*, room*) – ルームを削除する
• room/say (session*, room*, text*) – ルームメンバーにチャットメッセージを送る
• room/memberships (session*, room*) – ルームメンバーのユーザネーム一覧を取得する
• room/join (session*, room*) – ルームに参加する
• room/leave (session*, room*) – ルームを去る
• room/remove (session*, room*, user*) – ルームからユーザを外す
• room/lock (session*, room*) – ルームをロックして新規メンバーが入れないようにする
• room/unlock (session*, room*) – ルームをアンロックして新規メンバーが入れないようにする

Session

• session/create (game_key*, udid*, verifier*, os*, os_version*, hardware*, nickname*, version, lang, api_version, external_id, offline_version) – デバイスでログインしてセッションを発行する。同時に様々な関連情報も取得。
• session/create_by_password (game_key*, user*, password*, version, lang, api_version) – ログインしてセッションを発行する。同時にプレイヤー情報も取得。
• session/create_by_twitter (game_key*, user*, password*, version, lang, api_version) – リンクされているTwitterアカウントでログインしてセッションを発行する。
• session/create_by_social (game_key*, network*, token*, secret, version, lang, api_version) – リンクされているソーシャルアカウントでログインしてセッションを発行する。networkにはfacebook, twitterを指定。
• session/verify (session*) – ローカルキャッシュのsession_idが有効かどうか確認する
• session/touch (session*) – セッションを120-180秒延長する。セッションを作成後、60秒おきにこのメソッドを呼ぶことでセッションを確実に維持できます。セッションを引数にとるメソッドはすべてセッションの延長効果があるので、セッションの期限切れまでに何らかのAPI呼び出しを実行した場合にはこのメソッドを呼ぶ必要はありません。
• session/delete (session*) – セッションを破棄する

Social

• social/link (session*, network*, token*, secret) – アカウントをソーシャルネットワークにリンクする。networkに指定できるのはtwitter, facebook。tokenはOAuthのアクセストークン、secretはOAuthのアクセスシークレット（Facebookでは不要）
• social/unlink (session*, network*) – リンクを解除する
• social/tokens (session*) – アカウントにリンクされているソーシャルネットワークのトークンを一括取得する
• social/verify (session*, network*) – リンクの有効性を検証する

Subscription

• subscription/show (session*) – セッションで購読中のトピックの一覧を取得する
• subscription/add (session*, topic*) – 購読するトピックをセッションに追加する
• subscription/remove (session*, topic*) – 購読したくないトピックをセッションから削除する
• subscription/set (session*, topic*) – セッションで購読中のトピックを削除して指定のトピックで置き換える

Twitter (deprecated)

• twitter/link (session*, user*, password*) – TwitterのアカウントをxAuth認証でリンクする
• twitter/unlink (session*) – Twitterリンクを解除する
• twitter/verify (session*) – Twitterのリンクが有効か検証する
• twitter/friend_ids (session*) – Twitter上でフォローしているTwitterユーザのID一覧を取得する
• twitter/import_graph (session*) – Twitter上でフォローしているTwitterユーザのID一覧をインポートし、そのうちPankia上でリンク済みのユーザについてはPankia上でもフォローする
• twitter/say (session*, text*) – リンクしたTwitterアカウントで発言する

Upload

• upload/prepare (session*, filename*, content_type, expires_in) – アップロードの準備をする
• upload/commit (session*, filename*) – アップロードの完了をサーバへ通知する
• upload/delete (session*, filename*) – アップロードしたファイルを削除する

User

• user/show (session, user, include) – ユーザ情報を取得する。userが指定されてなければプレイヤー自身。includeにはenrollmentsが指定できる。
• user/find (session*, user*, include, offset, limit) – userで指定した文字列を、ユーザ名とtwitterユーザ名の両方から前半一致で検索し、見つかったユーザの一覧を取得する。includeにはenrollmentsが指定できる。
• user/find_random (session*, limit) – 同じゲームをプレイしているユーザをランダムに取得する。ユーザ数はlimitで指定し、デフォルト1。
• user/find_by_social (session*, network*, ids*) – ソーシャルネットワークのidにリンクされているユーザを取得する。idsはカンマ区切り、戻り値の順序は維持され、該当するユーザがいない場合にはnullになる。
• user/find_by_email (session*, emails*) – メールアドレスでユーザを検索する。emailsはカンマ区切り、戻り値の順序は維持され、該当するユーザがいない場合にはnullになる。
• user/search (session*, query*, country, age, gender, offset, limit, among) – 条件を指定してユーザを検索する。genderはMまたはF、ageには10-30のような記法で範囲を指定、amongはfolloweesまたはfriendsを指定することで、対象を絞り込める。
• user/secure (session*, email*, password*) – メールアドレスとパスワードをセットしてアカウントを確保する（メールアドレス確認のためリンクを送信）
• user/update (session*, username, email, fullname, password, icon_used, icon_data, blurb, birthdate, gender, update_ip, lat, lng, city) – プレイヤー情報を更新する（メールアドレスが変更されたら確認のためリンクを送信）。icon_usedはdefault, twitter, facebook, pankiaのいずれか。画像をアップロードするには、icon_used=pankiaを指定し、multipart/form-data形式でicon_dataに画像データをセットして送信する。birthdate=1970-01-02のようにISO8601形式でセットする。genderはMまたはFを指定する。update_ip=trueを指定することで、IPアドレス（およびcountryとcity）を更新する。lat,lngの有効数字は小数部6桁まで。cityはクライアントでreverse geocodingした正確な名称で明示的に更新したい場合に使用する。
• user/push (session*, user*, text*) – 詳細未定：ユーザにAPNs経由でプッシュメッセージ送信
• user/games (session*, user) – ユーザが遊んだことのあるゲーム一覧を取得する
• user/follow (session*, user*) – ユーザをフォローする
• user/unfollow (session*, user*) – ユーザをフォローから外す
• user/block (session*, user*) – ユーザをブロックして招待を受け取らなくする
• user/unblock (session*, user*) – ユーザをブロックから外す
• user/followers (session*, user, offset, limit) – 自分をフォローしているユーザの一覧を取得する。userが省略されたらプレイヤー自身の情報を取得。
• user/followees (session*, user, offset, limit, exclude_unenrolled) – 自分がフォローしているユーザの一覧を取得する。userが省略されたらプレイヤー自身の情報を取得。exclude_unenrolledにtrueを指定すると、ログインしているゲームにenrollしている人に絞り込む。
• user/unfriend (session*, user*) – 指定ユーザとの双方向のfollowを同時に外す。
• user/friends (session*, user, offset, limit) – フレンド（双方向にフォローしているユーザ）一覧を取得する。
• user/pending_friends (session*, offset, limit) – フレンド承認待ち（フォローされているがフォローバックしていない）ユーザの一覧をとる。
• user/blockees (session*, offset, limit) – 自分がブロックしているユーザの一覧を取得する。

Utility

• utility/get_location_by_ip (session*) – IPアドレスからcountry, cityを取得する
• utility/get_location_by_latlng (session*, lat*, lng*) – 緯度・経度からcountry, cityを取得する

Wall

• wall/show_feed (session*, before, limit, with_comments) – ユーザおよび友人の記事一覧を取得する。beforeはISO8601形式で指定する。with_commentsに上限数を指定することで、コメントを含めることができる。
• wall/show_articles (session*, user, before, limit, with_comments) – ユーザの記事一覧を取得する。beforeはISO8601形式で指定する。with_commentsに上限数を指定することで、コメントを含めることができる。
• wall/post_article (session*, user, title*, text*) – 記事を投稿する
• wall/post_comment (session*, article*, text*) – コメントを投稿する
• wall/like_article (session*, article*) – 記事をlikeする
• wall/unlike_article (session*, article*) – 記事をunlikeする
• wall/show_likes (session*, article*, offset, limit) – 記事をlikeしているユーザ一覧を取得し、自分自身が含まれるかどうかをmyself_includedでかえす。
• wall/show_comments (session*, article*, before, limit) – 記事についたコメント一覧を取得する。beforeはISO8601形式で指定する。
• wall/count_articles (session*, after) – after以降に作成・更新された記事の件数を取得する。afterはISO8601形式(2011-12-21T01:02:03Z)で指定する。
• wall/count_comments (session*, article*, after) – 記事についたコメントのafter以降の件数を取得する。afterはISO8601形式(2011-12-21T01:02:03Z)で指定する。