opensocial.DataRequest


メソッド

opensocial.DataRequest.add

サーバーからデータを取得、もしくは更新するアイテムを追加します。

パラメータ

名前

説明

request

Object

取得または更新するデータ

opt_key

String

応答データに結びつけるキー

返り値

なし

サンプル

opensocial.DataRequest.newFetchActivitiesRequest

サポートされていません。

opensocial.DataRequest.newFetchPeopleRequest

モバ友の情報を取得するリクエストを作成します。処理時に、Collection <Person> オブジェクトを返します。

パラメータ

名前

説明

idSpec

opensocial.IdSpec

取得するモバ友を特定するIdSpec

opt_params

Map.<opensocial.DataRequest.PeopleRequestFields|Object>

リクエストに追加するパラメータ

返り値

説明

Object

リクエストオブジェクト

サンプル

opensocial.DataRequest.newFetchPersonAppDataRequest

アプリケーションデータを取得するリクエストを作成します。処理時に、Map<PersonId, Map<String, Object>> オブジェクトを返します。

パラメータ

名前

説明

idSpec

opensocial.IdSpec

取得するモバ友を特定するIdSpec

keys

Array.<String> | String

データを要求するキー。キー名の配列、単独のキー名、「*」のいずれか

opt_params

Map.<opensocial.DataRequest.DataRequestFields|Object>

リクエストに追加するパラメータ

返り値

説明

Object

リクエストオブジェクト

サンプル

opensocial.DataRequest.newFetchPersonRequest

指定したユーザーのプロフィールを取得するリクエストを作成します。処理時に、 Person オブジェクトを返します。

パラメータ

名前

説明

id

String

取得するユーザーのID。もしくは VIEWER または OWNER の PersonId

opt_params

Map.<opensocial.DataRequest.PeopleRequestFields|Object>

リクエストに追加するパラメータ。 PROFILE_DETAILS をサポート

返り値

説明

Object

リクエストオブジェクト

サンプル

opensocial.DataRequest.newRemovePersonAppDataRequest

VIEWER のアプリケーションデータを削除するリクエストを作成します。処理時には何も返しません。

パラメータ

名前

説明

id

String

VIEWER のみ指定可能

keys

Array.<String>|String

データを要求するキー。キー名の配列、単独のキー名、「*」のいずれか

返り値

説明

Object

リクエストオブジェクト

サンプル

opensocial.DataRequest.newUpdatePersonAppDataRequest

VIEWER のアプリケーションデータを更新するリクエストを作成します。処理時には何も返しません。

パラメータ

名前

説明

id

String

VIEWER のみ指定可能

key

String

データを要求するキー アルファベット(A-Za-z)、数字(0-9)、アンダーバー(_)、ドット(.)、ハイフン(-) を含めることができます

返り値

説明

Object

リクエストオブジェクト

サンプル

opensocial.DataRequest.send

サーバーにデータリクエストを送信します。

パラメータ

名前

説明

opt_callback

Function

サーバーからレスポンスをパラメータとして呼び出すコールバック関数。

返り値

なし

サンプル

opensocial.DataRequest.DataRequestFields

opensocial.DataRequest.DataRequestFields.ESCAPE_TYPE

opensocial.EscapeTypeのうちから値を指定します。opensocial.EscapeType.HTML_ESCAPEを指定した場合はフィールドがhtmlエスケープされ、opensocial.EscapeType.NONEを指定した場合はエスケープを行いません。

opensocial.DataRequest.FilterType

opensocial.DataRequest.FilterType.ALL

サポートされていません。

opensocial.DataRequest.FilterType.HAS_APP

opensocial.DataRequestFields.FILTERの値として用います。このフィルタを用いた場合、アプリをインストール済みのユーザのデータのみが取得されます。

opensocial.DataRequest.FilterType.TOP_FRIENDS

サポートされていません。

opensocial.DataRequest.FilterType.IS_FRIENDS_WITH

サポートされていません。


opensocial.DataRequest.PeopleRequestFields

opensocial.DataRequest.PeopleRequestFields.PROFILE_DETAILS

newFetchPersonRequest, newFetchPeopleRequestなどにおいて、取得するプロフィール情報を指定します。

サンプル

opensocial.DataRequest.PeopleRequestFields.SORT_ORDER

サポートされていません。

opensocial.DataRequest.PeopleRequestFields.FILTER

opensocial.DataRequest.FilterTypeのうちから値を指定します。現在は、opensocial.DataRequest.FilterType.HAS_APPのみがサポートされています。

opensocial.DataRequest.PeopleRequestFields.FILTER_OPTIONS

サポートされていません。

opensocial.DataRequest.PeopleRequestFields.FIRST

peopleデータ取得の開始位置を自然数で指定します。通常、opensocial.DataRequest.PeopleRequestFields.MAXと同時に取得するデータのページングに用いられます。デフォルトの値は1です。

以下のサンプルでは取得するpeopleデータを5つずつのページに分けた上で、先頭から3番目のページとなる5人分のデータを取得します。なお、該当するページに指定した数のデータが存在しなかった場合は返せる分だけのデータが取得されます。

サンプル

opensocial.DataRequest.PeopleRequestFields.MAX

peopleデータ取得の最大数を自然数で指定します。通常、opensocial.DataRequest.PeopleRequestFields.FIRSTと同時に取得するデータのページングに用いられます。デフォルトの値は20です。

opensocial.DataRequest.SortOrder

opensocial.DataRequest.SortOrder.TOP_FRIENDS

サポートされていません。

opensocial.DataRequest.SortOrder.NAME

サポートされていません。

更新履歴

  • 2013/03/15
    • ドキュメント移行

PREVIOUS

opensocial.CreateActivityPriority

NEXT

opensocial.DataResponse