TextData
textdatagroup.create
TextdataGroup を作成するための API です。
API の定義
| REST Base URI | http://app.mbga-platform.jp/social/api/restful/v2 ( Service ) http://app.sb.mbga-platform.jp/social/api/restful/v2 ( Sandbox ) |
| REST HTTP Method | POST |
| REST URI Fragment | /textdata/{appId}/{groupId} |
| REST Query Parameters | Create-TextDataGroup-Request-Parameters |
| Return Object | なし |
認可
| type | permission | description |
|---|---|---|
| ANONYMOUS | false | 未認証でのアクセス |
| SECURITY_TOKEN | false | セキュリティトークンを用いた認証 |
| OAUTH_MOBILE | false | モバイル用で発行された OAuth Token を用いた認証 |
| OAUTH_CONSUMER | true | Consumer Request を用いた認証 |
RESTful API レスポンスコード
| HTTP Status Code | HTTP Status Message | JSON-RPC Error Codes | Meaning |
|---|---|---|---|
| 201 | Created | – | データの作成が成功した場合 |
| 400 | Bad Request | -32700, -32600, -32601, -32602, 400 | クライアント側のリクエストデータが不正です |
| 401 | Unauthorized | 401 | 認証エラーです |
| 403 | Forbidden | 403 | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 | Not Found | 404 | 存在しないリソースです |
| 405 | Method Not Allowed | 405 | その操作が許可されていない場合です |
| 500 | Internal Server Error | -32603 | API サーバー側のエラーです |
| 503 | Service Unavailable | – | 一時的に API が利用不可となっている場合です |
JSON-RPC エラーコード
エラー時の Error オブジェクトの code フィールドに含まれる値です。
| RPC Code | Meaning |
|---|---|
| -32700 (Parse error) | 不正な JSON format です |
| -32600 (Invalid Request) | 不正な JSON-RPC リクエストです |
| -32601 (Method not found) | 存在しないメソッドまたは利用不能なメソッドです |
| -32602 (Invalid params) | 不正な API リクエストパラメータです |
| -32603 (Internal server error) | API サーバー側のエラーです |
| 400 (Bad Request) | 他のエラーに該当しないクライアント側の不正なリクエストです |
| 401 (Unauthorized) | 認証エラーです |
| 403 (Forbidden) | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 (Not Found) | 存在しないリソースです |
| 405 (Method Not Allowed) | その操作が許可されていない場合です |
データ型
Create-TextDataGroup-Request-Parameters
appId, groupId は URI Template Parameters として指定し、それ以外のパラメータは Query String として指定します。
| Name | Type | Description |
|---|---|---|
| appId | AppId | Required '@app' のみ指定可能 |
| groupId | GroupId | Required '@all' のみ指定可能 |
ベースとなるデータ型
- Starndard-Request-Parameters
TextdataGroup
| Name | Type | Description |
|---|---|---|
| name | String | 作成する textdataGroup の名前です。 |
| parentId | String | 親子関係を表現するための id 値です。 |
name フィールド
英数字及びアンダースコアのみ利用可能です。最大32byte まで指定できます。
parentId フィールド
親子関係を表現する為に、子から見た親の id 値を入れるようになっています。監視の為に必要ですので親子関係のあるデータ構造の場合は必ず入れて下さい。
制限事項
1アプリケーションにつき作成できる TextDataGroup は 5 個になります。
サンプルデータ
RESTful API
新しい TextDataGroup を作成する
POST /social/api/restful/v2/textdata/@app/@all
{ "name": "diary" }
HTTP/1.1 201 Created
作成しようとした TextDataGroup がすでに存在しているか、TextDataGroup が 上限に達している場合 Bad Request となります。
POST /social/api/restful/v2/textdata/@app/@all
{ "name": "diary" }
HTTP/1.1 400 Bad Request
{
"Error" : {
"Code" : "400",
"Message" : "Bad Request"
}
}
textdatagroup.get
TextDataGroup の情報を取得するための API です。
API の定義
| REST Base URI | http://app.mbga-platform.jp/social/api/restful/v2 ( Service ) http://app.sb.mbga-platform.jp/social/api/restful/v2 ( Sandbox ) |
| REST HTTP Method | GET |
| REST URI Fragment | /textdata/{appId}/{groupId} ``` /textdata/{appId}/{textdataGroupName}{-prefix |
| REST Query Parameters | Get-TextDataGroup-Request-Parameters |
| Return Object | TextDataGroup Collection |
認可
| type | permission | description |
|---|---|---|
| ANONYMOUS | false | 未認証でのアクセス |
| SECURITY_TOKEN | false | セキュリティトークンを用いた認証 |
| OAUTH_MOBILE | false | モバイル用で発行された OAuth Token を用いた認証 |
| OAUTH_CONSUMER | true | Consumer Request を用いた認証 |
RESTful API レスポンスコード
| HTTP Status Code | HTTP Status Message | JSON-RPC Error Codes | Meaning |
|---|---|---|---|
| 200 | OK | – | データの取得が成功した場合 |
| 400 | Bad Request | -32700, -32600, -32601, -32602, 400 | クライアント側のリクエストデータが不正です |
| 401 | Unauthorized | 401 | 認証エラーです |
| 403 | Forbidden | 403 | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 | Not Found | 404 | 存在しないリソースです |
| 405 | Method Not Allowed | 405 | その操作が許可されていない場合です |
| 500 | Internal Server Error | -32603 | API サーバー側のエラーです |
| 503 | Service Unavailable | – | 一時的に API が利用不可となっている場合です |
JSON-RPC エラーコード
エラー時の Error オブジェクトの code フィールドに含まれる値です。
| RPC Code | Meaning |
|---|---|
| -32700 (Parse error) | 不正な JSON format です |
| -32600 (Invalid Request) | 不正な JSON-RPC リクエストです |
| -32601 (Method not found) | 存在しないメソッドまたは利用不能なメソッドです |
| -32602 (Invalid params) | 不正な API リクエストパラメータです |
| -32603 (Internal server error) | API サーバー側のエラーです |
| 400 (Bad Request) | 他のエラーに該当しないクライアント側の不正なリクエストです |
| 401 (Unauthorized) | 認証エラーです |
| 403 (Forbidden) | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 (Not Found) | 存在しないリソースです |
| 405 (Method Not Allowed) | その操作が許可されていない場合です |
データ型
Get-TextDataGroup-Request-Parameters
appId, groupId, textdataGroupName は URI Template Parameters として指定し、それ以外のパラメータは Query String として指定します。
| Name | Type | Description |
|---|---|---|
| appId | AppId | Required '@app' のみ指定可能 |
| groupId | GroupId | Required '@all' のみ指定可能 |
| textdataGroupName | String | TextDataGroup の名前です。 |
ベースとなるデータ型
- Standard-Request-Parameters
- Collection-Request-Parameters
Starndard-Request-Parameters
サポートしているフィールド一覧は下記になります。
| Name | Type | Description |
|---|---|---|
| format | String | Optional 'json' のみ指定可能 |
詳しくは 6.1 Standard Request Parameters - OpenSocial Core API Server Specification をご参照下さい。
Collection-Request-Parameters
サポートしているフィールド一覧は下記になります。
| Name | Type | Description |
|---|---|---|
| count | Number | Optional, 1以上1000以下の整数、デフォルト値は50 |
| startIndex | Number | Optional, 1以上の整数値 |
詳しくは 6.2 Collection Request Parameters - OpenSocial Core API Server Specification をご参照下さい。
TextDataGroup
| Name | Type | Description |
|---|---|---|
| id | String | TextDataGroup オブジェクトの id |
| name | String | TextDataGroup オブジェクトの名前 |
| appId | String | アプリケーションの id |
| parentId | String | 親に当る TextDataGroup オブジェクトの id |
サンプルデータ
RESTful API
TextDataGroup コレクションを取得する場合
GET /social/api/restful/v2/textdata/@app/@all
Host: app.sb.mbga-platform.jp
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"entry" : [
{
"parentId" : "0",
"appId" : "sb.mbga.jp:12000000",
"name" : "dialy",
"id" : "1"
},
{
"parentId" : "1",
"appId" : "sb.mbga.jp:12000000",
"name" : "comment",
"id" : "2"
},
],
"startIndex" : 1,
"itemsPerPage" : 50,
"totalResults" : 2
}
特定の TextDataGroup の 情報を取得する
GET /social/api/restful/v2/textdata/@app/diary/@self
Host: app.sb.mbga-platform.jp
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"parentId" : "0",
"appId" : "sb.mbga.jp:12000000",
"name" : "dialy",
"id" : "1"
}
textdatagroup.delete
TextDataGroup のエントリを削除するAPIです。
API の定義
| REST Base URI | http://app.mbga-platform.jp/social/api/restful/v2 ( Service ) http://app.sb.mbga-platform.jp/social/api/restful/v2 ( Sandbox ) |
| REST HTTP Method | DELETE |
| REST URI Fragment | ``` /textdata/{appId}/{textdataGroupName}{-prefix |
| REST Query Parameters | Delete-TextDataGroup-Request-Parameters |
| Return Object | Objecd-Id |
認可
| type | permission | description |
|---|---|---|
| ANONYMOUS | false | 未認証でのアクセス |
| SECURITY_TOKEN | false | セキュリティトークンを用いた認証 |
| OAUTH_MOBILE | false | モバイル用で発行された OAuth Token を用いた認証 |
| OAUTH_CONSUMER | true | Consumer Request を用いた認証 |
RESTful API レスポンスコード
| HTTP Status Code | HTTP Status Message | JSON-RPC Error Codes | Meaning |
|---|---|---|---|
| 201 | Accepted | – | データの削除が成功した場合 |
| 400 | Bad Request | -32700, -32600, -32601, -32602, 400 | クライアント側のリクエストデータが不正です |
| 401 | Unauthorized | 401 | 認証エラーです |
| 403 | Forbidden | 403 | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 | Not Found | 404 | 存在しないリソースです |
| 405 | Method Not Allowed | 405 | その操作が許可されていない場合です |
| 500 | Internal Server Error | -32603 | API サーバー側のエラーです |
| 503 | Service Unavailable | – | 一時的に API が利用不可となっている場合です |
JSON-RPC エラーコード
エラー時の Error オブジェクトの code フィールドに含まれる値です。
| RPC Code | Meaning |
|---|---|
| -32700 (Parse error) | 不正な JSON format です |
| -32600 (Invalid Request) | 不正な JSON-RPC リクエストです |
| -32601 (Method not found) | 存在しないメソッドまたは利用不能なメソッドです |
| -32602 (Invalid params) | 不正な API リクエストパラメータです |
| -32603 (Internal server error) | API サーバー側のエラーです |
| 400 (Bad Request) | 他のエラーに該当しないクライアント側の不正なリクエストです |
| 401 (Unauthorized) | 認証エラーです |
| 403 (Forbidden) | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 (Not Found) | 存在しないリソースです |
| 405 (Method Not Allowed) | その操作が許可されていない場合です |
データ型
Delete-TextDataGroup-Request-Parameters
appId, groupId, textdataGroupName は URI Template Parameters として指定し、それ以外のパラメータは Query String として指定します。
| Name | Type | Description |
|---|---|---|
| appId | AppId | Required '@app' のみ指定可能 |
| groupId | GroupId | Required '@self' のみ指定可能 |
| textdataGroupName | String | TextDataGroup の名前です。 |
ベースとなるデータ型
- Standard-Request-Parameters
Starndard-Request-Parameters
サポートしているフィールド一覧は下記になります。
| Name | Type | Description |
|---|---|---|
| format | String | Optional 'json' のみ指定可能 |
詳しくは 6.1 Standard Request Parameters - OpenSocial Core API Server Specification をご参照下さい。
サンプルデータ
RESTful API
TextDataGroup エントリーを削除する
DELETE /social/api/restful/v2/textdata/@app/diary/@self
Host: app.sb.mbga-platform.jp
HTTP/1.1 202 Accepted
"1"
textdata.create
TextData のエントリを作成する API です。
API の定義
| REST Base URI | http://app.mbga-platform.jp/social/api/restful/v2 ( Service ) http://app.sb.mbga-platform.jp/social/api/restful/v2 ( Sandbox ) |
| REST HTTP Method | POST |
| REST URI Fragment | ``` /textdata/{appId}/{textdataGroupName}{-prefix |
| REST Query Parameters | Create-TextData-Request-Parameters |
| Return Object | TextData |
認可
| type | permission | description |
|---|---|---|
| ANONYMOUS | false | 未認証でのアクセス |
| SECURITY_TOKEN | false | セキュリティトークンを用いた認証 |
| OAUTH_MOBILE | false | モバイル用で発行された OAuth Token を用いた認証 |
| OAUTH_CONSUMER | true | Consumer Request を用いた認証 |
RESTful API レスポンスコード
| HTTP Status Code | HTTP Status Message | JSON-RPC Error Codes | Meaning |
|---|---|---|---|
| 201 | Created | – | データの作成が成功した場合 |
| 400 | Bad Request | -32700, -32600, -32601, -32602, 400 | クライアント側のリクエストデータが不正です |
| 401 | Unauthorized | 401 | 認証エラーです |
| 403 | Forbidden | 403 | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 | Not Found | 404 | 存在しないリソースです |
| 405 | Method Not Allowed | 405 | その操作が許可されていない場合です |
| 500 | Internal Server Error | -32603 | API サーバー側のエラーです |
| 503 | Service Unavailable | – | 一時的に API が利用不可となっている場合です |
JSON-RPC エラーコード
エラー時の Error オブジェクトの code フィールドに含まれる値です。
| RPC Code | Meaning |
|---|---|
| -32700 (Parse error) | 不正な JSON format です |
| -32600 (Invalid Request) | 不正な JSON-RPC リクエストです |
| -32601 (Method not found) | 存在しないメソッドまたは利用不能なメソッドです |
| -32602 (Invalid params) | 不正な API リクエストパラメータです |
| -32603 (Internal server error) | API サーバー側のエラーです |
| 400 (Bad Request) | 他のエラーに該当しないクライアント側の不正なリクエストです |
| 401 (Unauthorized) | 認証エラーです |
| 403 (Forbidden) | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 (Not Found) | 存在しないリソースです |
| 405 (Method Not Allowed) | その操作が許可されていない場合です |
データ型
Create-TextData-Request-Parameters
appId, groupId, textdataGroupName は URI Template Parameters として指定し、それ以外のパラメータは Query String として指定します。
| Name | Type | Description |
|---|---|---|
| appId | AppId | Required '@app' のみ指定可能 |
| groupId | GroupId | Required '@all' のみ指定可能 |
| textdataGroupName | String | TextDataGroup の名前です。 |
ベースとなるデータ型
- Starndard-Request-Parameters
Starndard-Request-Parameters
サポートしているフィールド一覧は下記になります。
| Name | Type | Description |
|---|---|---|
| format | String | Optional 'json' のみ指定可能 |
詳しくは 6.1 Standard Request Parameters - OpenSocial Core API Server Specification をご参照下さい。
TextData
| Name | Type | Description |
|---|---|---|
| data | String | テキストデータ |
| parentId | String | 親に当たる TextData オブジェクトの id |
| writerId | String | このデータを書き込んだ人の UserId |
| ownerId | String | このデータの所有者の UserId |
注意事項
- data のサイズは 2048 byte までです。
- parentId は親子関係を表現する為に、子から見た親の id 値を入れるようになっています。監視の為に必要ですので親子関係のあるデータ構造の場合は必ず入れて下さい。
- data フィールドには文章と判断出来る文字列を入れて下さい。認識出来ない場合はオペレータにより削除される場合がありますのでご注意下さい。
- data フィールドに Mobage の運営ポリシーに反する禁止ワードが含まれる場合の TextData エントリの追加、更新は 400 Bad Request となります。
- TextData#ownerId は元の所有者、あるいは親データの所有者などを表現する為に用意されたフィールドです。
- 例としてユーザーごとに割り当てられた伝言板に任意のユーザーが書き込みをする場合、所有者は伝言板を割り当てられたユーザーとなる為、TextData#ownerId には所有者のIDを設定します。
- ユーザーによるエントリの作成・更新には、TextData#writerId を必ず設定して下さい。TextData#writerId を設定しない場合は、自動的に 0 が設定され、そのエントリはパートナーにより操作されたことを示します。
- TextData#ownerId のユーザーが viewer を black list に登録していた場合、BlackList API を使用して書き込みができないようにして下さい。
制限事項
- 各 TextDataGroup に格納できる最大エントリ数は アプリケーションをインストールしたユーザー数が 10,000 ユーザーまでは 100,000 件になります。
- 前日までのアプリケーションをインストールしたユーザー数が 10,000 ユーザーを超えた場合は、前日までの集計におけるインストールしたユーザー数 - 10 件になります。
- 最大エントリ数を超えた場合はそのグループに属するエントリで最も古いエントリから随時物理的に消されていきます。(404 Not Foundが返ります)
- 複数のカテゴリに属するTextDataを、1つのTextDataGroup IDで管理しないようお願いします。(例えば、「あいさつ」機能の投稿内容と「作戦会議」機能の投稿内容は、それぞれ別のTextDataGroup IDとしてください。なお、例えば「作戦会議」の投稿フォームに「タイトル」「作戦内容」の2つを別のカラムで入力させる場合は、1つのTextDataGroup IDとしてください。)
サンプルデータ
RESTful API
TextData エントリを作成する
10009 のユーザーのゲーム内マイページに設置されている伝言板に対して、10012 のユーザーがコメントをした例です。
POST /social/api/restful/v2/textdata/@app/comment/@all
Host: app.sb.mbga-platform.jp
{
"data": "怪盗ロワイヤルもやってます",
"writerId": "10012",
"ownerId": "10009"
}
HTTP/1.1 201 Created
{
"status" : 0,
"data" : "怪盗ロワイヤルもやってます",
"published" : "2010-10-04T09:05:28",
"writerId" : "sb.mbga.jp:10012",
"parentId" : "0",
"id" : "22",
"updated" : "2010-10-04T09:05:28",
"groupName" : "comment",
"ownerId" : "sb.mbga.jp:10009"
}
投稿しようとしたデータに禁止ワードが含まれた場合、 400 Bad Request が返ります。
POST /social/api/restful/v2/textdata/@app/comment/@all
Host: app.sb.mbga-platform.jp
{ "data": "掲示板等で「殺す」などと言うと投稿が運営側によって削除される場合があります" }
HTTP/1.1 400 Bad Reqeut
{
"Error" : {
"Code" : "400",
"Message" : "Bad Request"
}
}
textdata.get
TextData のエントリを取得する API です。
API の定義
| REST Base URI | http://app.mbga-platform.jp/social/api/restful/v2 ( Service ) http://app.sb.mbga-platform.jp/social/api/restful/v2 ( Sandbox ) |
| REST HTTP Method | GET |
| REST URI Fragment | ``` /textdata/{appId}/{textdataGroupName}{-prefix |
| REST Query Parameters | Get-TextData-Request-Parameters |
| Return Object | TextData Collection |
認可
| type | permission | description |
|---|---|---|
| ANONYMOUS | false | 未認証でのアクセス |
| SECURITY_TOKEN | false | セキュリティトークンを用いた認証 |
| OAUTH_MOBILE | false | モバイル用で発行された OAuth Token を用いた認証 |
| OAUTH_CONSUMER | true | Consumer Request を用いた認証 |
RESTful API レスポンスコード
| HTTP Status Code | HTTP Status Message | JSON-RPC Error Codes | Meaning |
|---|---|---|---|
| 200 | OK | – | データの取得が成功した場合 |
| 400 | Bad Request | -32700, -32600, -32601, -32602, 400 | クライアント側のリクエストデータが不正です |
| 401 | Unauthorized | 401 | 認証エラーです |
| 403 | Forbidden | 403 | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 | Not Found | 404 | 存在しないリソースです |
| 405 | Method Not Allowed | 405 | その操作が許可されていない場合です |
| 500 | Internal Server Error | -32603 | API サーバー側のエラーです |
| 503 | Service Unavailable | – | 一時的に API が利用不可となっている場合です |
JSON-RPC エラーコード
エラー時の Error オブジェクトの code フィールドに含まれる値です。
| RPC Code | Meaning |
|---|---|
| -32700 (Parse error) | 不正な JSON format です |
| -32600 (Invalid Request) | 不正な JSON-RPC リクエストです |
| -32601 (Method not found) | 存在しないメソッドまたは利用不能なメソッドです |
| -32602 (Invalid params) | 不正な API リクエストパラメータです |
| -32603 (Internal server error) | API サーバー側のエラーです |
| 400 (Bad Request) | 他のエラーに該当しないクライアント側の不正なリクエストです |
| 401 (Unauthorized) | 認証エラーです |
| 403 (Forbidden) | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 (Not Found) | 存在しないリソースです |
| 405 (Method Not Allowed) | その操作が許可されていない場合です |
データ型
Get-TextData-Request-Parameters
appId, groupId, textdataGroupName は URI Template Parameters として指定し、それ以外のパラメータは Query String として指定します。
| Name | Type | Description |
|---|---|---|
| appId | AppId | Required '@app' のみ指定可能 |
| groupId | GroupId | Required '@all' のみ指定可能 |
| textdataGroupName | String | TextDataGroup の名前です。 |
| fields | Array | Optional |
ベースとなるデータ型
- Starndard-Request-Parameters
- Collection-Request-Parameters
Starndard-Request-Parameters
サポートしているフィールド一覧は下記になります。
| Name | Type | Description |
|---|---|---|
| format | String | Optional 'json' のみ指定可能 |
詳しくは 6.1 Standard Request Parameters - OpenSocial Core API Server Specification をご参照下さい。
Collection-Request-Parameters
サポートしているフィールド一覧は下記になります。
| Name | Type | Description |
|---|---|---|
| filterBy | String or Array | Optional, 指定可能なフィールドは 'ownerId' と 'writerId' |
| filterOp | String or Array | Optional, 指定可能なオペレータは 'equals' のみ |
| filterValue | String or Array | Optional, filterBy を指定した場合は必須 |
| count | Number | Optional, 1以上1000以下の整数、デフォルト値は50 |
| sortBy | String | Optional, 指定可能なフィールドは 'id' または 'updated' |
| sortOrder | String | Optional, 'ascending' または 'descending' |
| startIndex | Number | Optional, 1以上の整数値 |
詳しくは 6.2 Collection Request Parameters - OpenSocial Core API Server Specification をご参照下さい。
TextData
| Name | Type | Description |
|---|---|---|
| id | String | TextData オブジェクトの id |
| groupName | String | TextDataGroup オブジェクトの name |
| parentId | String | 親に当たる TextData オブジェクトの id |
| writerId | String | このデータを書き込んだ人の UserId |
| ownerId | String | このデータの所有者の UserId |
| data | String | テキストデータ |
| status | Number | 論理ステータス値 |
| published | DateTime | 生成日時 |
| updated | DateTime | 更新日時 |
status フィールド
| status | Description |
|---|---|
| 0 | 通常 |
| 11 | ユーザーによる編集 |
| 21 | オペレーターによる編集 |
| 31 | パートナーによる編集 |
注意事項
- API からのレスポンスに含まれる DateTime 型の形式にはタイムゾーン指定子は含まれていません。従ってGMT(グリニッジ標準時)での表記となっております。
- id を複数指定した GET は同一グループ内の id のみを指定して下さい。異なるグループに属する id は取得する事が出来ません。
サンプルデータ
RESTful API
TextData コレクションを取得する
comment に所属している TextData 一覧を writerId が 小さい順にソートして、2エントリーづつ取得する例です。
GET /social/api/restful/v2/textdata/@app/comment/@all?sortBy=writerId&sortOrder=ascending&count=2
Host: app.sb.mbga-platform.jp
HTTP/1.1 200 OK
{
"entry" : [
{
"status" : 0,
"data" : "comment01",
"writerId" : "sb.mbga.jp:12345",
"published" : "2010-10-10T10:10:10",
"parentId" : "0",
"groupName" : "comment",
"updated" : "2010-10-10T10:10:10",
"id" : "10",
"ownerId" : "sb.mbga.jp:23456"
},
{
"status" : 21,
"data" : "comment02",
"writerId" : "sb.mbga.jp:23456",
"published" : "2010-10-10T11:11:11",
"parentId" : "0",
"groupName" : "comment",
"updated" : "2010-10-10T12:00:00",
"id" : "12",
"ownerId" : "sb.mbga.jp:0"
}
],
"startIndex" : 1,
"sorted" : true,
"itemsPerPage" : 2,
"totalResults" : 12,
"filtered" : false
}
存在しない groupName を指定した場合は、 404 Not Found が返ってきます。
GET /social/api/restful/v2/textdata/@app/unknown/@all
Host: app.sb.mbga-platform.jp
HTTP/1.0 404 Not Found
{
"Error" : {
"Code" : "404",
"Message" : "Not Found"
}
}
TextData エントリーを取得する
フィールドを指定して取得する例です。
GET /social/api/restful/v2/textdata/@app/comment/@all/10?fields=data,writerId,status
Host: app.sb.mbga-platform.jp
HTTP/1.1 200 OK
{
"writerId" : "sb.mbga.jp:12345",
"status" : 0,
"data" : "comment01"
}
存在しない textdataId を指定した場合、 404 Not Found が返ります。
GET /social/api/restful/v2/textdata/@app/unknown/@all/9999
Host: app.sb.mbga-platform.jp
HTTP/1.0 404 Not Found
{
"Error" : {
"Code" : "404",
"Message" : "Not Found"
}
}
TextData.id を複数指定しての TextData エントリの取得
GET /social/api/restful/v2/textdata/@app/comment/@all/10,20?fields=data,writerId,status,id
Host: app.sb.mbga-platform.jp
HTTP/1.1 200 OK
{
"entry" : [
{
"status" : 0,
"data" : "comment01",
"writerId" : "sb.mbga.jp:12345",
"id" : "10",
},
{
"status" : 21,
"data" : "comment02",
"writerId" : "sb.mbga.jp:23456",
"id" : "20",
}
],
"startIndex" : 1,
"sorted" : false,
"itemsPerPage" : 50,
"totalResults" : 2,
"filtered" : false
}
textdata.update
TextData のエントリを更新する API です。
API の定義
| REST Base URI | http://app.mbga-platform.jp/social/api/restful/v2 ( Service ) http://app.sb.mbga-platform.jp/social/api/restful/v2 ( Sandbox ) |
| REST HTTP Method | PUT |
| REST URI Fragment | ``` /textdata/{appId}/{textdataGroupName}/{groupId}{-prefix |
| REST Query Parameters | Update-TextData-Request-Parameters |
| Return Object | なし |
認可
| type | permission | description |
|---|---|---|
| ANONYMOUS | false | 未認証でのアクセス |
| SECURITY_TOKEN | false | セキュリティトークンを用いた認証 |
| OAUTH_MOBILE | false | モバイル用で発行された OAuth Token を用いた認証 |
| OAUTH_CONSUMER | true | Consumer Request を用いた認証 |
RESTful API レスポンスコード
| HTTP Status Code | HTTP Status Message | JSON-RPC Error Codes | Meaning |
|---|---|---|---|
| 202 | Accepted | – | データの更新が成功した場合 |
| 400 | Bad Request | -32700, -32600, -32601, -32602, 400 | クライアント側のリクエストデータが不正です |
| 401 | Unauthorized | 401 | 認証エラーです |
| 403 | Forbidden | 403 | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 | Not Found | 404 | 存在しないリソースです |
| 405 | Method Not Allowed | 405 | その操作が許可されていない場合です |
| 500 | Internal Server Error | -32603 | API サーバー側のエラーです |
| 503 | Service Unavailable | – | 一時的に API が利用不可となっている場合です |
JSON-RPC エラーコード
エラー時の Error オブジェクトの code フィールドに含まれる値です。
| RPC Code | Meaning |
|---|---|
| -32700 (Parse error) | 不正な JSON format です |
| -32600 (Invalid Request) | 不正な JSON-RPC リクエストです |
| -32601 (Method not found) | 存在しないメソッドまたは利用不能なメソッドです |
| -32602 (Invalid params) | 不正な API リクエストパラメータです |
| -32603 (Internal server error) | API サーバー側のエラーです |
| 400 (Bad Request) | 他のエラーに該当しないクライアント側の不正なリクエストです |
| 401 (Unauthorized) | 認証エラーです |
| 403 (Forbidden) | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 (Not Found) | 存在しないリソースです |
| 405 (Method Not Allowed) | その操作が許可されていない場合です |
データ型
Update-TextData-Request-Parameters
appId, groupId, textdataGroupName は URI Template Parameters として指定し、それ以外のパラメータは Query String として指定します。
| Name | Type | Description |
|---|---|---|
| appId | AppId | Required '@app' のみ指定可能 |
| groupId | GroupId | Required '@all' のみ指定可能 |
| textdataGroupName | String | TextDataGroup の名前です。 |
ベースとなるデータ型
- Starndard-Request-Parameters
Starndard-Request-Parameters
サポートしているフィールド一覧は下記になります。
| Name | Type | Description |
|---|---|---|
| format | String | Optional 'json' のみ指定可能 |
詳しくは 6.1 Standard Request Parameters - OpenSocial Core API Server Specification をご参照下さい。
TextData
| Name | Type | Description |
|---|---|---|
| data | String | テキストデータ |
| parentId | String | 親に当たる TextData オブジェクトの id |
| writerId | String | このデータを書き込んだ人の UserId |
| ownerId | String | このデータの所有者の UserId |
注意事項
- data のサイズは 2048 byte までです。
- ユーザーによるエントリの作成・更新には、TextData#writerId を必ず設定して下さい。
サンプルデータ
RESTful API
TextData エントリを更新する
PUT /social/api/restful/v2/textdata/@app/comment/@all/20
Host: app.sb.mbga-platform.jp
{
"data": "Lv30 になりました!",
"writerId": "23456"
}
HTTP/1.1 202 Accepted
- 投稿しようとしたデータに禁止ワードが含まれた場合、 400 Bad Request が返ります。
- 存在しない textdataId を指定した場合、404 Not Found が返ります。
- writerIdが設定されていない場合の値は自動的に「0」になります。
textdata.delete
TextData のエントリを削除する API です。
API の定義
| REST Base URI | http://app.mbga-platform.jp/social/api/restful/v2 ( Service ) http://app.sb.mbga-platform.jp/social/api/restful/v2 ( Sandbox ) |
| REST HTTP Method | DELETE |
| REST URI Fragment | ``` /textdata/{appId}/{textdataGroupName}/{groupId}{-prefix |
| REST Query Parameters | Delete-TextData-Request-Parameters |
| Return Object | ObjectId |
認可
| type | permission | description |
|---|---|---|
| ANONYMOUS | false | 未認証でのアクセス |
| SECURITY_TOKEN | false | セキュリティトークンを用いた認証 |
| OAUTH_MOBILE | false | モバイル用で発行された OAuth Token を用いた認証 |
| OAUTH_CONSUMER | true | Consumer Request を用いた認証 |
RESTful API レスポンスコード
| HTTP Status Code | HTTP Status Message | JSON-RPC Error Codes | Meaning |
|---|---|---|---|
| 202 | Accepted | – | データの削除が成功した場合 |
| 400 | Bad Request | -32700, -32600, -32601, -32602, 400 | クライアント側のリクエストデータが不正です |
| 401 | Unauthorized | 401 | 認証エラーです |
| 403 | Forbidden | 403 | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 | Not Found | 404 | 存在しないリソースです |
| 405 | Method Not Allowed | 405 | その操作が許可されていない場合です |
| 500 | Internal Server Error | -32603 | API サーバー側のエラーです |
| 503 | Service Unavailable | – | 一時的に API が利用不可となっている場合です |
JSON-RPC エラーコード
エラー時の Error オブジェクトの code フィールドに含まれる値です。
| RPC Code | Meaning |
|---|---|
| -32700 (Parse error) | 不正な JSON format です |
| -32600 (Invalid Request) | 不正な JSON-RPC リクエストです |
| -32601 (Method not found) | 存在しないメソッドまたは利用不能なメソッドです |
| -32602 (Invalid params) | 不正な API リクエストパラメータです |
| -32603 (Internal server error) | API サーバー側のエラーです |
| 400 (Bad Request) | 他のエラーに該当しないクライアント側の不正なリクエストです |
| 401 (Unauthorized) | 認証エラーです |
| 403 (Forbidden) | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 (Not Found) | 存在しないリソースです |
| 405 (Method Not Allowed) | その操作が許可されていない場合です |
データ型
Delete-TextData-Request-Parameters
appId, groupId, textdataGroupName は URI Template Parameters として指定し、それ以外のパラメータは Query String として指定します。
| Name | Type | Description |
|---|---|---|
| appId | AppId | Required '@app' のみ指定可能 |
| groupId | GroupId | Required '@all' のみ指定可能 |
| textdataGroupName | String | TextDataGroup の名前です。 |
ベースとなるデータ型
-
Starndard-Request-Parameters
Starndard-Request-Parameters
サポートしているフィールド一覧は下記になります。
Name Type Description format String Optional 'json' のみ指定可能
詳しくは 6.1 Standard Request Parameters - OpenSocial Core API Server Specification をご参照下さい。
注意事項
- 削除されたデータは GET でエントリリソースを取得しても 404 Not Found となります。
サンプルデータ
RESTful API
TextData エントリを削除する
DELETE /social/api/restful/v2/textdata/@app/comment/@all/20
Host: app.sb.mbga-platform.jp
HTTP/1.1 202 Accepted
すでに削除されている textdataId を指定した場合や、存在しない textdataId を指定した場合、404 Not Found が返ります。
DELETE /social/api/restful/v2/textdata/@app/comment/@all/20
Host: app.sb.mbga-platform.jp
HTTP/1.1 404 Not Found
{
"Error" : {
"Code" : "404",
"Message" : "Not Found"
}
}
参考資料
OpenSocial Core API Server Specification 1.0
OpenSocial Core Data Specification 1.0
OpenSocial Social API Server Specification 1.0
OpenSocial Social Data Specification 1.0
更新履歴
- 2014/07/24
- TextData エントリ更新に関する注意事項を追加
- 2012/06/05
- status 削除フィールド値を削除
- 2011/07/13
- 注意事項のエントリ作成時のownerIdに関する情報を削除
- 2010/12/24
- TextData の削除に関する情報を加筆修正
- オペレータによる削除に関する注意事項を修正
- 2010/11/24
- textdatagroup.update の Method を修正
- 2010/11/09
- オペレータによる削除に関する注意事項を追加
- 2010/11/04
- textdata.delete を行った場合、そのエントリを textdata.get で取得することができなくなりました
- 2010/10/18
- textdatagroup.create の注意事項、サンプルを修正
- 2010/10/06
- sb.dena.jp -> sb.mbga.jp に修正