自由文の入力・表示をする

概要

Mobageオープンプラットフォームではユーザーからの自由文入力を取得・保存する API が用意されています。保存されているテキストは監視対象となります。

事前準備

このAPIを利用するには Gadget XMLで Require 要素で mbga feature の仕様を宣言する必要があります。

TextDataGroup の作成

TextData オブジェクトをグルーピングする為の TextDataGroup オブジェクトは事前に Trusted Model (OAuth Consumer Request) による API アクセスで作成しておく必要があります。

TextDataGroup オブジェクトの生成に関しては、こちらを参考にしてください。

自由文の入力

自由文をサーバーに作成するためのサンプルは以下のようになります。

  • パラメータとして入力したい自由文を TEXTDATA に、TEXT_DATA_GROUP_NAME に保存したい TextDataGroup の名前を指定します。
  • requestCreateTextData() メソッドを利用して TextData オブジェクトをサーバーに生成します。
  • コールバック関数には生成された TextData オブジェクトが返ります。

自由文の表示

作成した自由文を取得するサンプルは以下のようになります。

  • TEXTDATA_GROUP_NAME に保存した TextDataGroup の名前、TEXTDATA_ID に TextData オブジェクトの ID を指定します。
  • newDataRequest() で DataRequest オブジェクトを生成します。
  • newFetchTextDataRequest() にパラメータを指定して DataRequest に追加します。
  • send() メソッドでサーバーにリクエストを送信します。
  • コールバック関数が取得された TextData が含まれて呼ばれます。

自由文の変更・削除

作成した自由文の変更例は以下になります。

  • パラメータとして変更したい自由文を TEXTDATA に、対象TEXT_DATA_GROUP_NAME に保存した TextDataGroup の名前を、TEXTDATA_ID に変更したい TextData オブジェクトの ID を指定します。
  • requestUpdateTextData() メソッドを利用して TextData オブジェクトの変更リクエストをサーバーに要求します。
  • コールバック関数には NULL オブジェクトが返ります。

作成した自由文のを削除するには以下のようにします。

  • パラメータとして TEXT_DATA_GROUP_NAME に保存した TextDataGroup の名前を、TEXTDATA_ID に削除したい TextData オブジェクトの ID を指定します。
  • requestRemoveTextData() メソッドを利用して TextData オブジェクトをの削除リクエストをサーバーに要求します。
  • コールバック関数には 削除された TextData の ID が返ります。

制限事項

現在、TextData には以下の制限があります。

  • 1アプリケーションにつき作成できる TextDataGroup は 5 個になります。
  • 各 TextDataGroup に格納できる最大エントリ数は アプリケーションをインストールしたユーザー数が 10,000 ユーザーまでは 100,000 件になります
    • 前日までのアプリケーションをインストールしたユーザー数が 10,000 ユーザーを超えた場合は、前日までの集計におけるインストールしたユーザー数 - 10 件になります。
  • 最大エントリ数を超えた場合はそのグループに属するエントリで最も古いエントリから随時論理的に消されていきます。(status 値が 20 になります)
  • 論理削除されたデータの内、削除日から3ヶ月経過しているデータに関しては物理的に削除されます。この場合に削除された TextData エントリリソースは存在しない事になり、GET でエントリリソースを取得しても 404 Not Found となります。

更新履歴

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

PREVIOUS

アバターを取得する

NEXT

アイテム課金をする