TPStashEvent.Record

public int Record(
    string method_name,
    params KeyValuePair<string, object>[] param_pairs
);

説明

TPStashEventのクラスのメソッド名やパラメータ名を直接に入力するメソッドとなります。

以下は`Record`メソッドに`Join`メソッドとパラメータを入れたサンプルコードです。

使用例
TPStashEvent myStashEvent = new TPStashEvent();
KeyValuePair<string, object>[] parameters = new KeyValuePair<string, object>[]
{
    new KeyValuePair<string, object>("player_uuid", "myPlayerID"),
};
myStashEvent.Record("Join", parameters);

データのアップロードに成功した場合1をリターンし、成功できなかった場合には-1をリターンします。-1リターンとなった場合TentuPlay debug modeに設定されている状態でUnity Editorを使用している場合、Unity Editorコンソールから以下のメッセージが表示されます。

TPError||ERROR inserting table_name: exception_error_message

パラメータ保存先

パラメータ保存先はRecordメソッドを使用する際に特定の条件下でTPStashEventクラスメソッドで最も頻繁に使われるパラメータ(player_uuidcharacter_uuid)を省略できるようにする機能です。

具体的にはRecordメソッドを使ってLoginAsCharacterを呼び出すと、player_uuidcharacter_uuidがパラメータ保存先に保存され、それ以降はJoinLoginAppLoginAsCharacter[LoginAsCharacter]を除くすべてのメソッドでplayer_uuidcharacter_uuidパラメータを省略することができます。

この際にLoginAsCharacterメソッドを他のメソッド(JoinLoginAppを除く)より先に呼び出す必要があり、パラメータ保存先を使用してもJoinLoginAppLoginAsCharacterメソッドは引き続きplayer_uuidcharacter_uuidパラメータを必要とします。

  • このパラメータ保存先はメモリーに存在し、予期せぬエラーを起こす可能性があるため、特別な状況ではない限り使用は控えてください。

  • また、player_uuidcharacter_uuidがない場合はデータが収集されず、欠損データが発生するため、注意してください。

  • パラメータ保存先に保存されているplayer_uuidcharacter_uuidは、PlayStageメソッドにも同じく反映されますが、PlayStageではcharacter_uuidではなくcharacter_uuidsを受け取るため、複数のキャラクターでプレイするゲームではPlayStageを呼び出す場合にパラメータリストにcharacter_uuidを追加する必要があります。

保存先の数値の変更
  • パラメータの保存先にあるplayer_uuidcharacter_uuidを変更したい場合にはLoginAsCharacterplayer_uuidcharacter_uuidを新しく指定し、呼び出す必要があります。

  • player_uuidcharacter_uuidの数値は、個別に修正することができません。

  • パラメータの保存先に数値が入っている状態で、メソッドのパラメータplayer_uuidcharacter_uuidを指定すると、そのままパラメータとして入力されます。ただし、パラメータの保存先に上書きされません。

パラメータ

名前 説明 必須か

method_name

TPStashEventクラス内のメソッド名

メソッド名は大文字と小文字を区別しません。

必須

param_pairs

Keyと値がペアになっているパラメータ

  • 必須パラメータがない場合、Recordメソッドはエラー(-1)を返します。

  • オプションパラメータに無効な値を指定するとエラー(-1)を返します。

KeyはTPStashEventクラス内メソッドのパラメータ名です。

  • 名前は大文字と小文字を区別しません。

  • 一つのparam_pairsに同じKeyを重複して使用する場合、配列の順番に応じて上書きされます。

  • 必須パラメータの場合、必ずKeyが必要となります。

Valueはパラメータの値です。

  • データ型はパラメータのデータ型またはstringです。

  • 必須パラメータの場合、値をNULLにしてはなりません。

データ型
名前 説明

String array

空の配列ではない文字列配列(string array)やカンマで区切られる場合もあります。

Enum

各パラメータで定められた列挙型で定数名、数字型または数字型の文字列以外はエラーを返します。

必須