メインコンテンツまでスキップ
非公開のページ
このページは非公開です。 検索対象外となり、このページのリンクに直接アクセスできるユーザーのみに公開されます。

Achievement

概要​

Achievement API を用いると、Mobage Developers に設定された Achievement の オブジェクトを取得することができます。

Achievement には、Achievement ID を指定しないで取得する方法と、Achievement ID を指定して取得する方法の 2 通りがあり、それぞれリクエスト方法が異なります。

Achievement オブジェクトフィールド​

Achievement を表すオブジェクトになります。

値説明型補足
appIdアプリケーション識別子string
idアチーブメント識別子string
name名称string
revealedDescriptionREVEALED の際の説明文string
unlockedDescriptionUNLOCKED の際の説明文string
typeアチーブメント種別string
totalSteps達成までのステップ数integer
stepFormatステップの表示上の単位string
point獲得ポイントinteger
repeatable反復可能フラグboolean
disclosed公開状態フラグboolean
defaultState初期ステート値string
revealedIconUrlsREVEALED の際の画像 url リストarray
revealedIconUrls[].typeREVEALED の際の画像タイプstring
revealedIconUrls[].valueREVEALED の際の画像 urlstring
revealedIconUrls[].primaryREVEALED の際の画像の優先度boolean
unlockedIconUrlsUNLOCKED の際の画像 url リストarray
unlockedIconUrls[].typeUNLOCKED の際の画像タイプstring
unlockedIconUrls[].valueUNLOCKED の際の画像 urlstring
unlockedIconUrls[].primaryUNLOCKED の際の画像の優先度boolean
published作成日時string
updated更新日時string

Achievement を指定しないで取得する方法​

API リクエスト​

HTTP メソッド​

Authorization Code Grant​
  • GET
    • Achievement を指定しないで取得する
Client Credentials Grant​
  • GET
    • Achievement を指定しないで取得する

エンドポイント​

  • Sandbox 環境

    https://sb-app.mobage.jp/social/api/restful/v2/achievements{/appId}{?format,startIndex,count,sortBy,sortOrder,fields}
  • 本番環境

    https://app.mobage.jp/social/api/restful/v2/achievements{/appId}{?format,startIndex,count,sortBy,sortOrder,fields}
    URI Template パラメータ​
    appId​

    appId パラメータは下記のいずれかの値を指定します。

    値説明備考
    @app現在実行中のアプリケーション ID必須
    {appId}個々に割り振られたアプリケーション ID必須

クエリパラメータ​

下記のクエリパラメータを指定する事が出来ます。

format​

レスポンス形式を指定する事が出来ます。json のみ指定可能です。

値説明備考
json"application/json; charset=utf8"任意、デフォルト値
fields​

取得したいプロフィール属性情報を指定する事が出来ます。指定可能なフィールド名については Achievement オブジェクトフィールドを参照して下さい。
複数指定する場合はスペース無しのカンマ (,) 区切りで指定します。
fields パラメータを省略した場合、下記の属性情報全てを取得します。

パフォーマンス向上の為に、必要な属性のみを取得するようにして下さい。何も指定しない場合に取得できるデフォルトフィールドは以下になります。

["id", "type", "point"]
count​

コレクションリソースとしてレスポンスを取得する際に、最大何件のエントリリソースを取得するかを指定出来ます。selector に @friends, @all を指定した場合に指定出来ます。

デフォルト値は 50 件で、最大 1000 件まで指定出来ます。

startIndex​

コレクションリソースの開始値を指定します。省略時は 1 が指定されます。例えば、全体で 100 件ある友達情報のページ送りで 1 ページ辺り 8 件表示し、2 ページ目の情報を取得したい場合、count 値に 8 を指定し、startIndex 値に 9 を指定します。

sortBy​

sortBy と sortOrder を指定すると、レスポンスとして返って来る Achievement オブジェクトのコレクションに対してソート条件を加える事が出来ます。sortBy 値はソートのキーとなるフィールドを指定する事が出来ます。

指定可能な sortBy 値は以下の表になります。

sortBy説明
idアチーブメント識別子
point獲得ポイント

sortBy を指定する場合、sortOrder も指定されている必要があります。

sortOrder​

sortBy と sortOrder を指定すると、レスポンスとして返って来る Achievement オブジェクトのコレクションに対してソート条件を加える事が出来ます。sortOrder 値はソート時の昇順、降順を指定する事が出来ます。

指定可能な sortOrder 値は以下の表になります。

sortOrder説明
ascending昇順
descending降順

sortOrder を指定する場合、sortBy も指定されている必要があります。

API レスポンス​

レスポンスコード​

API のレスポンスコードは以下のいずれかになります。

リクエスト HTTP メソッドレスポンスコードレスポンスメッセージ説明
GET200OK正常にデータ取得が完了しました
GET400Bad Requestリクエストデータが不正です
GET401UnauthorizedOAuth による認可が失敗しています
GET403Forbidden認証エラー以外の理由でアクセス出来ない場合です
GET405Method Not Allowedメソッドが許可されていません
GET500Internal Server ErrorAPI 側の問題による失敗です
GET503Service UnavailableAPI 側の一時的なエラーです

レスポンスのデータ構造​

API のレスポンスの payload として返されるデータ構造です。

propertytitletypedescription
entryAchievement リソースのリストarray
entry[].appIdアプリケーション識別子string
entry[].idアチーブメント識別子string
entry[].name名称string
entry[].revealedDescriptionREVEALED の際の説明文string
entry[].unlockedDescriptionUNLOCKED の際の説明文string
entry[].typeアチーブメント種別string
entry[].totalSteps達成までのステップ数integer
entry[].stepFormatステップの表示上の単位string
entry[].point獲得ポイントinteger
entry[].repeatable反復可能フラグboolean
entry[].disclosed公開状態フラグboolean
entry[].defaultState初期ステート値string
entry[].revealedIconUrlsREVEALED の際の画像 url リストarray
entry[].revealedIconUrls[].typeREVEALED の際の画像タイプstring
entry[].revealedIconUrls[].valueREVEALED の際の画像 urlstring
entry[].revealedIconUrls[].primaryREVEALED の際の画像の優先度boolean
entry[].unlockedIconUrls[]UNLOCKED の際の画像 url リストarray
entry[].unlockedIconUrls[].typeUNLOCKED の際の画像タイプstring
entry[].unlockedIconUrls[].valueUNLOCKED の際の画像 urlstring
entry[].unlockedIconUrls[].primaryUNLOCKED の際の画像の優先度boolean
entry[].published作成日時string
entry[].updated更新日時string
startIndex開始インデックスinteger
itemsPerPageページごとのエントリ数integer
totalResults総エントリ数integer
sortedソート適用フラグbooleanソートが適用された場合に true になります。(Default では id でソートされるため、常に true になります)

サンプル​

count パラメータを指定した場合​
リクエスト形式​
GET /achievements/@app?count=5
Authorization: OAuth oauth_parameters
レスポンス形式​
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Pragma: no-cache

{
"entry": [
{ "id": 1, "type": "INCREMENTAL", "point": 1000 },
{ "id": 2, "type": "STANDARD", "point": 250 },
{ "id": 3, "type": "INCREMENTAL", "point": 370 },
{ "id": 4, "type": "INCREMENTAL", "point": 120 },
{ "id": 5, "type": "STANDARD", "point": 110 }
],
"startIndex": 1,
"itemsPerPage": 5,
"totalResults": 12
}
sortBy, sortOrder を指定した場合​
リクエスト形式​
GET /achievements/@app?sortBy=point&sortOrder=descending&count=5
Authorization: OAuth oauth_parameters
レスポンス形式​
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Pragma: no-cache

{
"entry": [
{ "id": 1, "type": "INCREMENTAL", "point": 1000 },
{ "id": 3, "type": "INCREMENTAL", "point": 370 },
{ "id": 2, "type": "STANDARD", "point": 250 },
{ "id": 4, "type": "INCREMENTAL", "point": 120 },
{ "id": 5, "type": "STANDARD", "point": 110 }
],
"startIndex": 1,
"itemsPerPage": 5,
"totalResults": 12
}