OpenSocial Host | ヘルプ | Core API ヘルプ | ユーザー登録 （無料） | ログイン

OpenSocial Host

ガイダンス

  • Core API の概要
  • Core API の呼び出し （PC）
  • Core API の呼び出し （モバイル）
  • サポートフォーラム
  • トレーニング

リファレンス （PC）

  • /app/register
  • /data/insert
  • /data/update
  • /data/delete
  • /data/select
  • /data/search
  • /payment/poncan/search
  • /payment/payca/search
  • /access/insert
  • permission
  • match
  • sort
  • errorCode

リファレンス （モバイル）

  • /rest/(container)/people/select
  • /rest/(container)/activities/insert
  • /rest/(container)/appdata/insert
  • /rest/(container)/appdata/update
  • /rest/(container)/appdata/delete
  • /rest/(container)/appdata/select
  • /rest/(container)/albums/select
  • /rest/(container)/messages/insert
  • /data/insert
  • /data/update
  • /data/delete
  • /data/select
  • /data/search
  • /payment/poncan/search
  • /payment/payca/search
  • /access/insert
  • mode
  • selector
  • filterOp
  • format
  • permission
  • match
  • sort
  • errorCode

リファレンス （mixi 拡張）

  • お問い合わせ

リファレンス （モバゲー TOWN 拡張）

  • お問い合わせ
  • ヘルプ
  • チュートリアル
  • Core API
  • JavaScript API

ガイダンス

Core API の概要

OpenSocial Host の Core API は、JavaScript API がその内部で呼び出すより低級な API です。JavaScript API は Core API の全機能をサポートしているため、MySpace 等、script タグの埋め込みが禁止されているコンテナ、または Flash ベースのアプリケーション以外では極力 JavaScript API を利用するようにしてください。

Core API の呼び出し （PC）

PC のアプリケーションの場合、Core API は OpenSocial の gadgets.io.makeRequest （署名付き POST リクエスト） を経由して呼び出してください。

サンプルコード 
var data = { application_key: 'Your Application Key' };
var params = {};
params[gadgets.io.RequestParameters.AUTHORIZATION] =
    gadgets.io.AuthorizationType.SIGNED;
params[gadgets.io.RequestParameters.CONTENT_TYPE] =
    gadgets.io.ContentType.JSON;
params[gadgets.io.RequestParameters.METHOD] =
    gadgets.io.MethodType.POST;
params[gadgets.io.RequestParameters.POST_DATA] =
    gadgets.io.encodeValues(data);

gadgets.io.makeRequest(
    'http://opensocialhost.com/app/register',
    function (response) {
        if (response && response.data) {
            ...
        }
    },
    params);

Core API の呼び出し （モバイル）

モバイルのアプリケーションの場合、Core API は gadgets.io.makeRequest を経由して呼び出す必要はありません。通常の HTTP リクエストとして呼び出してください。

サポートフォーラム

Core API のご利用に関するご質問、ご要望はサポートフォーラムまでお願いします。

トレーニング

弊社では OpenSocial Host のトレーニング （無料） を常時実施しています。トレーニングを受講されたい方はお気軽にお問い合わせください。

リファレンス （PC）

http://opensocialhost.com/app/register

Application Key の不正利用を防止するため、Application Key とアプリケーションの識別子 （opensocial_app_url／opensocial_app_id） を結び付けます。

この API はアプリケーションの開発を始める際に一度だけ呼び出してください。（新しいアプリケーションを開発する場合、まず新しい Application Key を取得する必要があります。）

パラメーター application_key string
Application Key
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/data/insert

外部データベースにデータを挿入します。

パラメーター key1
key2
...
key10		 string
挿入したいデータの key
value1
value2
...
value10		 string
挿入したいデータの value
read_permission string （詳細）
挿入したいデータの読み込みパーミッション
指定しない場合は public
read_permission_specified string
read_permission が specified の場合
読み込みのできるユーザーを
opensocial.Person.getId で指定する
write_permission string （詳細）
挿入したいデータの書き込みパーミッション
指定しない場合は private
write_permission_specified string
write_permission が specified の場合
書き込みのできるユーザーを
opensocial.Person.getId で指定する
戻り値
(json)		 hadError bool
エラーが発生した場合は true
そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/data/update

外部データベースのデータを更新します。

パラメーター key1
key2
...
key10		 string
更新したいデータの key
value1
value2
...
value10		 string
更新したいデータの value
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/data/delete

外部データベースのデータを削除します。

パラメーター key1
key2
...
key10		 string
削除したいデータの key
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/data/select

外部データベースのデータを取得します。

パラメーター key1
key2
...
key10		 string
取得したいデータの key
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード
data array
key と value のペアを含む json オブジェクトの配列

http://opensocialhost.com/data/search

外部データベースのデータを検索します。

パラメーター key string
key に対する検索ワード
value string
value に対する検索ワード
page integer
ページ番号
デフォルトは 1
per_page integer
ページ辺りの検索結果の数
デフォルトは 10、最大は 100
match string （詳細）
検索方法
指定しない場合は like
sort string （詳細）
検索結果の降順／昇順
指定しない場合は desc
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード
page integer
ページ番号
per_page integer
ページ辺りの検索結果の数
total_counts integer
全体の検索結果の数
data array
key と value のペアを含む json オブジェクトの配列

http://opensocialhost.com/payment/poncan/search

poncan の決済ログを検索します。

パラメーター rid string
成果 ID
date string
期間 （"20100501-20100601" のように "YYYYMMDD-YYYYMMDD" 形式で指定する）
page integer
ページ番号
デフォルトは 1
per_page integer
ページ辺りの検索結果の数
デフォルトは 10、最大は 100
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード
page integer
ページ番号
per_page integer
ページ辺りの検索結果の数
total_counts integer
全体の検索結果の数
data array
poncan の決済ログを含む json オブジェクトの配列

http://opensocialhost.com/payment/payca/search

payca の決済ログを検索します。

パラメーター product_key string
プロダクトキー
date string
期間 （"20100501-20100601" のように "YYYYMMDD-YYYYMMDD" 形式で指定する）
page integer
ページ番号
デフォルトは 1
per_page integer
ページ辺りの検索結果の数
デフォルトは 10、最大は 100
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード
page integer
ページ番号
per_page integer
ページ辺りの検索結果の数
total_counts integer
全体の検索結果の数
data array
payca の決済ログを含む json オブジェクトの配列

http://log.opensocialhost.com/access/insert

アクセスログにデータを挿入します。

パラメーター application_key string
Application Key
view string
gadgets.views.ViewType
href string
ページのアドレス
referer string
ページのリファラー
agent string
ユーザーエージェント
height integer
ブラウザーの高さ
width integer
ブラウザーの幅
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

permission

  • public
  • 誰にでも読み込み、または書き込みを許可
  • friends
  • 友達にまで読み込み、または書き込みを許可 （未実装）
  • friends_of_friends
  • 友達の友達にまで読み込み、または書き込みを許可 （未実装）
  • gadget
  • ガジェットをインストールしたユーザーにのみ読み込み、または書き込みを許可 （未実装）
  • private
  • 自分にのみ読み込み、または書き込みを許可
  • specified
  • 特定のユーザーにのみ読み込み、または書き込みを許可

match

  • like
  • 部分一致で検索する
  • prefix
  • 前方一致で検索する
  • suffix
  • 後方一致で検索する

sort

  • desc
  • 検索結果を降順で返却する
  • asc
  • 検索結果を昇順で返却する

errorCode

  • BAD_REQUEST
  • 不正なリクエスト
  • FORBIDDEN
  • 許可されないデータへのアクセス
  • INTERNAL_ERROR
  • サーバーエラー
  • LIMIT_EXCEEDED
  • データベース使用量、または API 使用回数の超過
  • CONTAINER
  • コンテナエラー
  • UNAUTHORIZED
  • 不正な Application Key

リファレンス （モバイル）

http://opensocialhost.com/rest/(container)/people/select

指定のユーザーや指定のユーザーの友達のプロフィールを取得します。

（container には mixi もしくは mbga を指定してください。）

パラメーター token string
セッショントークン （getToken を指定する）
sandbox integer
サンドボックスを使用する場合は 1 （モバゲー TOWN 専用）
requestor string
ビューアーの ID
guid string
対象となるユーザーの ID または @me
selector string （詳細）
セレクター
pid string
セレクターの対象となるユーザーの ID （絞り込む場合）
startIndex integer
ページコレクションのインデックス
count integer
ページコレクションのサイズ
fields string
検索結果に含めるフィールドのリスト （カンマ区切り）
filterBy string
検索結果をフィルタするフィールド
filterOp string （詳細）
検索結果をフィルタする方法
filterValue string
検索結果をフィルタする値
format string （詳細）
戻り値のフォーマット
戻り値 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード
data string
プロフィール

http://opensocialhost.com/rest/(container)/activities/insert

アクティビティを通知します。

（container には mixi もしくは mbga を指定してください。）

パラメーター token string
セッショントークン （getToken を指定する）
sandbox integer
サンドボックスを使用する場合は 1 （モバゲー TOWN 専用）
requestor string
ビューアーの ID
guid string
対象となるユーザーの ID または @me
selector string （詳細）
セレクター
data string
アクティビティを含む json オブジェクトの文字列
startIndex integer
ページコレクションのインデックス
count integer
ページコレクションのサイズ
fields string
検索結果に含めるフィールドのリスト （カンマ区切り）
filterBy string
検索結果をフィルタするフィールド
filterOp string （詳細）
検索結果をフィルタする方法
filterValue string
検索結果をフィルタする値
format string （詳細）
戻り値のフォーマット
戻り値 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/rest/(container)/appdata/insert

OpenSocial コンテナが提供する永続データにデータを挿入します。

（container には mixi もしくは mbga を指定してください。）

パラメーター token string
セッショントークン （getToken を指定する）
sandbox integer
サンドボックスを使用する場合は 1 （モバゲー TOWN 専用）
requestor string
ビューアーの ID
guid string
対象となるユーザーの ID または @me
selector string （詳細）
セレクター
data string
key と value のペアを含む json オブジェクトの文字列
startIndex integer
ページコレクションのインデックス
count integer
ページコレクションのサイズ
fields string
検索結果に含めるフィールドのリスト （カンマ区切り）
filterBy string
検索結果をフィルタするフィールド
filterOp string （詳細）
検索結果をフィルタする方法
filterValue string
検索結果をフィルタする値
format string （詳細）
戻り値のフォーマット
戻り値 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/rest/(container)/appdata/update

OpenSocial コンテナが提供する永続データのデータを更新します。

（container には mixi もしくは mbga を指定してください。）

パラメーター token string
セッショントークン （getToken を指定する）
sandbox integer
サンドボックスを使用する場合は 1 （モバゲー TOWN 専用）
requestor string
ビューアーの ID
guid string
対象となるユーザーの ID または @me
selector string （詳細）
セレクター
data string
key と value のペアを含む json オブジェクトの文字列
startIndex integer
ページコレクションのインデックス
count integer
ページコレクションのサイズ
fields string
検索結果に含めるフィールドのリスト （カンマ区切り）
filterBy string
検索結果をフィルタするフィールド
filterOp string （詳細）
検索結果をフィルタする方法
filterValue string
検索結果をフィルタする値
format string （詳細）
戻り値のフォーマット
戻り値 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/rest/(container)/appdata/delete

OpenSocial コンテナが提供する永続データのデータを削除します。

（container には mixi もしくは mbga を指定してください。）

パラメーター token string
セッショントークン （getToken を指定する）
sandbox integer
サンドボックスを使用する場合は 1 （モバゲー TOWN 専用）
requestor string
ビューアーの ID
guid string
対象となるユーザーの ID または @me
selector string （詳細）
セレクター
startIndex integer
ページコレクションのインデックス
count integer
ページコレクションのサイズ
fields string
検索結果に含めるフィールドのリスト （カンマ区切り）
filterBy string
検索結果をフィルタするフィールド
filterOp string （詳細）
検索結果をフィルタする方法
filterValue string
検索結果をフィルタする値
format string （詳細）
戻り値のフォーマット
戻り値 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/rest/(container)/appdata/select

OpenSocial コンテナが提供する永続データのデータを取得します。

（container には mixi もしくは mbga を指定してください。）

パラメーター token string
セッショントークン （getToken を指定する）
sandbox integer
サンドボックスを使用する場合は 1 （モバゲー TOWN 専用）
requestor string
ビューアーの ID
guid string
対象となるユーザーの ID または @me
selector string （詳細）
セレクター
startIndex integer
ページコレクションのインデックス
count integer
ページコレクションのサイズ
fields string
検索結果に含めるフィールドのリスト （カンマ区切り）
filterBy string
検索結果をフィルタするフィールド
filterOp string （詳細）
検索結果をフィルタする方法
filterValue string
検索結果をフィルタする値
format string （詳細）
戻り値のフォーマット
戻り値 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード
data string
永続データ

http://opensocialhost.com/rest/(container)/albums/select

指定のユーザーや指定のユーザーの友達のアルバムを取得します。

（container には mixi を指定してください。）

パラメーター token string
セッショントークン （getToken を指定する）
requestor string
ビューアーの ID
guid string
対象となるユーザーの ID または @me
selector string （詳細）
セレクター
album string
アルバム ID
アルバム ID に null を指定する場合はアルバムの一覧を取得、
アルバム ID を指定する場合はそのアルバムの詳細を取得
startIndex integer
ページコレクションのインデックス
count integer
ページコレクションのサイズ
fields string
検索結果に含めるフィールドのリスト （カンマ区切り）
filterBy string
検索結果をフィルタするフィールド
filterOp string （詳細）
検索結果をフィルタする方法
filterValue string
検索結果をフィルタする値
format string （詳細）
戻り値のフォーマット
戻り値 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード
data string
アルバムの一覧または詳細

http://opensocialhost.com/rest/(container)/messages/insert

メッセージを送信します。

（container には mbga を指定してください。）

パラメーター token string
セッショントークン （getToken を指定する）
sandbox integer
サンドボックスを使用する場合は 1 （モバゲー TOWN 専用）
mode string （詳細）
リクエストモデル （モバゲー TOWN 専用）
requestor string
ビューアーまたはアプリケーションの ID
guid string
対象となるユーザーの ID または @me
selector string （詳細）
セレクター
data string
メッセージを含む json オブジェクトの文字列
startIndex integer
ページコレクションのインデックス
count integer
ページコレクションのサイズ
fields string
検索結果に含めるフィールドのリスト （カンマ区切り）
filterBy string
検索結果をフィルタするフィールド
filterOp string （詳細）
検索結果をフィルタする方法
filterValue string
検索結果をフィルタする値
format string （詳細）
戻り値のフォーマット
戻り値 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/data/insert

外部データベースにデータを挿入します。

パラメーター token string
セッショントークン （getToken を指定する）
opensocial_owner_id string
オーナーの ID
opensocial_viewer_id string
ビューアーの ID
key1
key2
...
key10		 string
挿入したいデータの key
value1
value2
...
value10		 string
挿入したいデータの value
read_permission string （詳細）
挿入したいデータの読み込みパーミッション
指定しない場合は public
read_permission_specified string
read_permission が specified の場合
読み込みのできるユーザーを
opensocial.Person.getId で指定する
write_permission string （詳細）
挿入したいデータの書き込みパーミッション
指定しない場合は private
write_permission_specified string
write_permission が specified の場合
書き込みのできるユーザーを
opensocial.Person.getId で指定する
戻り値
(json)		 hadError bool
エラーが発生した場合は true
そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/data/update

外部データベースのデータを更新します。

パラメーター token string
セッショントークン （getToken を指定する）
opensocial_owner_id string
オーナーの ID
opensocial_viewer_id string
ビューアーの ID
key1
key2
...
key10		 string
更新したいデータの key
value1
value2
...
value10		 string
更新したいデータの value
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/data/delete

外部データベースのデータを削除します。

パラメーター token string
セッショントークン （getToken を指定する）
opensocial_owner_id string
オーナーの ID
opensocial_viewer_id string
ビューアーの ID
key1
key2
...
key10		 string
削除したいデータの key
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

http://opensocialhost.com/data/select

外部データベースのデータを取得します。

パラメーター token string
セッショントークン （getToken を指定する）
opensocial_owner_id string
オーナーの ID
opensocial_viewer_id string
ビューアーの ID
key1
key2
...
key10		 string
取得したいデータの key
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード
data array
key と value のペアを含む json オブジェクトの配列

http://opensocialhost.com/data/search

外部データベースのデータを検索します。

パラメーター token string
セッショントークン （getToken を指定する）
opensocial_owner_id string
オーナーの ID
opensocial_viewer_id string
ビューアーの ID
key string
key に対する検索ワード
value string
value に対する検索ワード
page integer
ページ番号
デフォルトは 1
per_page integer
ページ辺りの検索結果の数
デフォルトは 10、最大は 100
match string （詳細）
検索方法
指定しない場合は like
sort string （詳細）
検索結果の降順／昇順
指定しない場合は desc
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード
page integer
ページ番号
per_page integer
ページ辺りの検索結果の数
total_counts integer
全体の検索結果の数
data array
key と value のペアを含む json オブジェクトの配列

http://opensocialhost.com/payment/poncan/search

poncan の決済ログを検索します。

パラメーター token string
セッショントークン （getToken を指定する）
opensocial_owner_id string
オーナーの ID
opensocial_viewer_id string
ビューアーの ID
rid string
成果 ID
date string
期間 （"20100501-20100601" のように "YYYYMMDD-YYYYMMDD" 形式で指定する）
page integer
ページ番号
デフォルトは 1
per_page integer
ページ辺りの検索結果の数
デフォルトは 10、最大は 100
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード
page integer
ページ番号
per_page integer
ページ辺りの検索結果の数
total_counts integer
全体の検索結果の数
data array
poncan の決済ログを含む json オブジェクトの配列

http://opensocialhost.com/payment/payca/search

payca の決済ログを検索します。

パラメーター token string
セッショントークン （getToken を指定する）
opensocial_owner_id string
オーナーの ID
opensocial_viewer_id string
ビューアーの ID
product_key string
プロダクトキー
date string
期間 （"20100501-20100601" のように "YYYYMMDD-YYYYMMDD" 形式で指定する）
page integer
ページ番号
デフォルトは 1
per_page integer
ページ辺りの検索結果の数
デフォルトは 10、最大は 100
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード
page integer
ページ番号
per_page integer
ページ辺りの検索結果の数
total_counts integer
全体の検索結果の数
data array
payca の決済ログを含む json オブジェクトの配列

http://log.opensocialhost.com/access/insert

アクセスログにデータを挿入します。

パラメーター token string
セッショントークン （getToken を指定する）
opensocial_owner_id string
オーナーの ID
opensocial_viewer_id string
ビューアーの ID
view string
gadgets.views.ViewType
href string
ページのアドレス
referer string
ページのリファラー
agent string
ユーザーエージェント
height integer
ブラウザーの高さ
width integer
ブラウザーの幅
戻り値
(json)		 hadError bool
エラーが発生した場合は true、そうでない場合は false
errorCode string （詳細）
エラーコード

mode

  • proxy
  • Proxy モデルで送信する
  • trusted
  • Trusted モデルで送信する

selector

  • @self
  • guid で指定するユーザー
  • @friends
  • guid で指定するユーザーの友達
  • @all
  • guid で指定するユーザーの全ての関係者
  • @outbox
  • メッセージのコレクション （/rest/(container)/messages/insert 専用）

filterOp

  • equals
  • filterValue の値と等しい

format

  • json
  • JSON フォーマット
  • atom
  • ATOM フォーマット

permission

  • public
  • 誰にでも読み込み、または書き込みを許可
  • friends
  • 友達にまで読み込み、または書き込みを許可 （未実装）
  • friends_of_friends
  • 友達の友達にまで読み込み、または書き込みを許可 （未実装）
  • gadget
  • ガジェットをインストールしたユーザーにのみ読み込み、または書き込みを許可 （未実装）
  • private
  • 自分にのみ読み込み、または書き込みを許可
  • specified
  • 特定のユーザーにのみ読み込み、または書き込みを許可

match

  • like
  • 部分一致で検索する
  • prefix
  • 前方一致で検索する
  • suffix
  • 後方一致で検索する

sort

  • desc
  • 検索結果を降順で返却する
  • asc
  • 検索結果を昇順で返却する

errorCode

  • BAD_REQUEST
  • 不正なリクエスト
  • FORBIDDEN
  • 許可されないデータへのアクセス
  • INTERNAL_ERROR
  • サーバーエラー
  • LIMIT_EXCEEDED
  • データベース使用量、または API 使用回数の超過
  • CONTAINER
  • コンテナエラー
  • UNAUTHORIZED
  • 不正な Application Key

リファレンス （mixi 拡張）

お問い合わせ

OpenSocial Host は Classmates API 等、mixi の独自の拡張にも対応しています。mixi のパートナー様には仕様をお伝えできますので、ご希望の方はお気軽にお問い合わせください。

リファレンス （モバゲー TOWN 拡張）

お問い合わせ

OpenSocial Host は Avatar API 等、モバゲー TOWN の独自の拡張にも対応しています。モバゲー TOWN のパートナー様には仕様をお伝えできますので、ご希望の方はお気軽にお問い合わせください。

利用規約 | プライバシーポリシー | サポートフォーラム | 開発ブログ | お問い合わせ
Copyright © 2006 - 2012 HeartRails Inc. All Rights Reserved.