共通仕様

APIリファレンス

CREYLEアプリプラットフォームの共通仕様です。
CREYLEアプリプラットフォームでは、OpenSocial 0.8、0.9に準拠し、いくつかの拡張を行っております。

サポートしているサービス

APIサービス名	できること
people	自分や友人やサイトのメンバーなどのプロフィール情報を取得したり、自分のプロフィール情報を更新したりすることができます。}
activities	自分や友人やサイトのメンバーなどのアクティビティ（更新情報）を取得したり、自分のアクティビティを投稿したりすることができます。
appdata	自分や友人などの永続化データ（アプリの設定情報等）を取得したり、自分の永続化データを更新したりすることができます。
xSites	サイトの情報を取得することができます。このAPIはCREYLE独自のものです。
xEntries	エントリの情報を取得したり更新したりすることができます。このAPIはCREYLE独自のものです。
xComments	エントリのコメントを取得したり更新したりすることができます。このAPIはCREYLE独自のものです。
mediaitems	エントリの画像を取得したり更新したりすることができます。 CREYLEではエントリを一つのアルバムと見立て、エントリに対して画像をアップロードしたりといった操作を行います。このAPIはOpenSocial-v0.9のCREYLE独自拡張です。

サポートしているFeature

analytics
[参考] iGoogle ガジェットの作り方 : Google Analytics ライブラリ - WebOS Goodies
content-rewrite
[参考] 天使やカイザーと呼ばれて: Content Rewriter Feature (0.9)
dynamic-height
[参考] 入門ガジェットの高さを動的に変更する (OpenSocial大技林(予))
flash
[参考] ユーザーインターフェースの作成 - ガジェット - Google Code
minimessage
[参考] Gadgets API リファレンス - OpenSocial - Google Code
opensocial-0.8
[参考] OpenSocial API リファレンス - OpenSocial - Google Cod
opensocial-0.9
[参考] Opensocial (v0.9) - OpenSocial
osapi
tabs
[参考] ユーザーインターフェースの作成 - ガジェット - Google Code
views
[参考] ユーザーインターフェースの作成 - ガジェット - Google Code

共通パラメータ

各APIはそれぞれ固有のパラメータを必要とします。
それ以外の、各API共通で情報の絞り込みや追加、結果の並び順の指定を行うパラメータが以下の共通パラメータです。

パラメータ	値	説明
count	数値	リストを取得する場合、検索結果の最大件数を指定する。現時点のデフォルト値は100
filterBy	フィールド名	リストを取得する場合、絞り込みに利用するフィールドを指定する
filterOp	equals	filterByで指定したフィールドがfilterValueで指定した値と一致するものだけ抽出する
	contains	filterByで指定したフィールドにfilterValueで指定した値が含まれるものだけ抽出する
	startsWith	filterByで指定したフィールドがfilterValueで指定した値で始まるものだけ抽出する
	present	filterByで指定したフィールドに有効な値があるものだけ抽出する。現時点では存在しないフィールドが指定された場合、無効になる
filterValue	任意の値
fields	フィルター名からなる配列	結果として取得するリソースに含めるフィールドを指定する。利用可能なフィールドは各サービスの「サポートしているフィールド」を参照。表中の「フィールド名」が指定可能な値です
sortBy	フィールド名	リストを取得する場合、ソートに利用するフィールドを指定する
sortOrder	ascending	sortByで指定したフィールドを昇順でソートする。 sortOrderが指定されなかった場合はこの値が指定される
sortOrder	descending	sortByで指定したフィールドを降順でソートする
startIndex	数値	リストを取得する場合、検索結果の開始位置を指定する
updatedSince	2009-06-15T 00:00:00Z形式の日時	リストを取得する場合、指定した日時以降のものだけ抽出する

サンプルコード

// 閲覧者(viewer)の友達を取得する
//共通パラメータを指定して、取得開始位置を3番目、取得件数を2件に絞る
osapi.people.get({
  count:2, //一回あたり取得件数
  startIndex:3, //取得開始番号
  groupId:"@friends",
  userId:"@viewer"
}).execute(function(result){
  // {
  //   itemsPerPage : 2,
  //   startIndex   : 3,
  //   list : [ // listはpeopleの配列
  //     {
  //       displayName : "ニックネーム",
  //       id : "creyle.jp:12345",
  //       isOwner : 0,
  //       isViewer : 0,
  //       published : "2009-04-30T05:26:45Z",
  //       thumbnailUrl : "http://upload.creyle.jp/profile/00/00/0000/0000-0000.m.jpg",
  //       updated : "2009-04-30T05:57:51Z",
  //       utcOffset : "+09:00"
  //     }, { }
  //   ]
  // }
});

コメントを書く

APIリファレンス

共通仕様

サポートしているサービス

サポートしているFeature

共通パラメータ

サンプルコード

コメント

デベロッパー

What's New

みんなの伝言板