Activity

概要

Activity とは自分の行動履歴を記録する API です。記録された Activity は自分の友達のマイページに時系列順に表示されます。
Activity の生成は非同期で実行されるので、マイページに表示されるまでに若干の遅延が発生する場合があります。


Activity オブジェクトフィールド

Mobageオープンプラットフォームで対応している Activity オブジェクトのフィールド一覧です。

説明

名前空間

補足

title

アクティビティのタイトル

xs:string

http://ns.opensocial.org/2008/opensocial

ユーザーからの自由入力文を設定しないようにして下さい。

url

アクティビティの参照 URL (PC 向け)

xs:string

http://ns.opensocial.org/2008/opensocial

省略時にはアプリケーショントップの url となります

touchUrl

アクティビティの参照 URL (スマートフォンWeb向け)

xs:string

http://ns.dena.jp/mbga/gameapi/v1

省略時にはアプリケーショントップの url となります

body

アクティビティの本文

xs:string

http://ns.opensocial.org/2008/opensocial

ユーザーからの自由入力文は設定しないようにして下さい

mediaItems

アクティビティに関連する写真

xs:MediaItem (unbounded)

http://ns.opensocial.org/2008/opensocial

最大3つの MediaItem を登録出来ます。PC 版では 75 x 75 で表示されます

MediaItem オブジェクトフィールド

説明

名前空間

補足

url

画像の URL

xs:string

http://ns.opensocial.org/2008/opensocial

type

MediaItem の種別

xs:string

http://ns.opensocial.org/2008/opensocial

'image' のみ指定可能

mime_type

MediaItem の MimeType

xs:string

http://ns.opensocial.org/2008/opensocial

'image/gif', 'image/jpeg', 'image/png'


API リクエスト

HTTP メソッド

Proxy モデル

  • POST

Trusted モデル


エンドポイント URL

  • Sandbox 環境
    http://sb.app.mbga.jp/api/restful/v1/activities/{guid}/{selector}/{appid}
  • 本番環境
    http://app.mbga.jp/api/restful/v1/activities/{guid}/{selector}/{appid}

URI Template パラメータ

guid

guid パラメータは @me のみ指定出来ます。

説明

備考

@me

viewer の guid

必須

selector

selector パラメータは @self のみ指定出来ます。

説明

備考

@self

guid パラメータで指定したユーザー自身の Activity 情報に関するコレクションリソース

必須

appid

appid パラメータは @app のみ指定出来ます。

説明

備考

@app

viewer が実行中のアプリケーション ID

必須


クエリパラメータ

特にありません。


API レスポンス

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

リクエスト HTTP メソッド

レスポンスコード

レスポンスメッセージ

説明

POST

202

Accepted

Activity の生成リクエストを正常に受け付けた状態です

POST

400

Bad Request

リクエストデータが不正です

POST

401

Unauthorized

OAuth による認可が失敗しています

POST

403

Forbidden

認証エラー以外の理由でアクセス出来ない場合です

POST

405

Method Not Allowed

メソッドが許可されていません

POST

500

Internal Server Error

API 側の問題による失敗です

POST

503

Service Unavailable

制限を超えて、同一ユーザーの Activity を POST した場合

 


注意事項

  • title, body に HTML を含める事は出来ません
  • title, body にユーザーからの自由入力文を設定しないようにして下さい。
  • title は半角42文字、全角21文字以内に収まるようにして下さい。
    • 実際の表示では時刻と短縮ゲーム名が先頭に入ります。
  • body は半角280文字、全角140文字以内に収まるようにして下さい。
  • 特定のユーザーに対する Activity の記録は1分間に1回までにして下さい。制限を超えたリクエストを送った場合は 503 Service Unavailable が返って来ます。
  • title, body に絵文字は使用できません。
  • 後方互換性の為に暫くの間は url のみを指定した場合は mobileUrl として扱われます。
    • PC 向け及びモバイル向け、スマートフォンWeb向けに個別に指定したい場合は url, mobileUrl, touchUrl をそれぞれ指定します。デフォルトの挙動をさせたい場合は空文字列を指定します。
    • モバイルのみの場合は mobileUrl のみを指定するようにして下さい。
    • mobileUrl パラメータを併記する場合に指定出来る url パラメータは PC のアプリケーションのトップ または起動画面 のみです。sandbox の場合のドメインは sb.yahoo-mbga.jp になります。またいずれも appParams を用いてガジェット実行時の view-params として渡す事が可能です。
      PC トップ:http://yahoo-mbga.jp/game/{appId}
      PC 起動画面:http://yahoo-mbga.jp/game/{appId}/play
  • Activity API を利用した Activity の送信では priority が LOW 扱いになります。
    • LOW の場合は、全ての友達ではなくアプリケーションをインストールしている友達にのみ Activity が表示されます。
    • LOW の場合は、マイページトップには表示されません。「友達のゲーム状況」の「もっと見る」でのみ表示されます。
    • HIGH として送信されたい場合は Activity API ではなく、アクティビティサービス をご利用下さい。
  • mediaItems を配列で複数指定した場合、モバイル側の表示は配列の先頭に指定した画像のみとなります。
  • ユーザーがそのアプリケーションをインストールしていない場合、レスポンスコードは 403 が返ります。

サンプル

viewer の Activity を生成

リクエスト形式

POST /api/restful/v1/activities/@me/@self/@app
Content-Type: application/json

{
   "url": "http://sb.app.mbga.jp/game/12000129/play?appParams=test",
   "mobileUrl" : "http://example.com/foo/bar",
   "title" : "新しい勲章「モバゆび」をゲット"
}

レスポンス形式

202 Accepted

画像付きの Activity を送信

リクエスト形式

POST /api/restful/v1/activities/@me/@self/@app
Content-Type: application/json

{
    "body": "ふくびきけんをゲットしたら街でふくびきをしてみよう",
    "mediaItems": [
        {
            "url": "http://example.com/img/example.jpg",
            "type": "image",
            "mime_type": "image/jpeg"
        }
    ],
    "url": "http://example.com/", 
    "mobileUrl": "http://example.com/mobile",
    "title": "トモちゃんはふくびきけんをゲットした!"
}

レスポンス形式

202 Accepted

 

参考資料

OpenSocial RESTful Protocol Specification v0.9 - 7.3 Activity
XML Schema Part 2: Datatypes Second Edition
URI Template draft-gregorio-uritemplate-03
OAuth Request Body Hash 1.0 Draft 4
 

更新履歴

  • 2013/10/01
    • OAuth Signed Request (xoauth_requestor_id) に関する記述を削除しました。
  • 2012/06/28
    • ニュース掲載 API 改修 の対応に関する記述を追加
  • 2011/02/21
    • touchUrl について追記
  • 2011/01/27
    • 注意事項の Activity の Priority に関する記述を修正
  • 2011/01/25
    • 注意事項に mediaItems に関する記述を追加
  • 2011/01/24
    • Activity オブジェクトフィールドの body, mediaItems の記述を修正
  • 2011/01/20
    • 注意事項に Activity の priority に関する記述を追加
 

PREVIOUS

People

NEXT

Message