SDK 移行ガイド

Update your User Reporting implementation from version 1.0 to version 2.0 to access the latest features and updates.

読み終わるまでの所要時間 2 分

最終更新 1日前

User Reporting SDK が更新され、API 全体に影響が及びました。最も重要な点として、開発の焦点とサポート範囲のために、パブリック API の範囲が大幅に縮小されました。

注意

重要: これは、以前のバージョンの SDK を使用している場合、新しいバージョンに移行しない限り更新を受け取れないことを意味します。古いバージョンは、新機能の開発が進むにつれて Unity Dashboard や User Reporting バックエンドの今後の変更と互換性がなくなる可能性があります。

User Reporting 1.0 は古い SDK を指し、こちらでリファレンス配布を入手できます。User Reporting 2.0 は、Unity Package Manager で提供されている更新された SDK を指します。

重要な変更点

API 全体が、
```
Unity.Services.UserReporting
```
名前空間に配置されるようになりました。
この API は、
```
Unity.Services.UserReporting.Instance
```
を介して単一のアクセスポイントを使用します。
ソースコード全体が公開されなくなり、
```
CyclicalList
```
などのヘルパーを SDK で利用できなくなりました。
SDK は、
```
SimpleJSON
```
パーサーや
```
PngHelper
```
クラス (いずれも削除されました) などのソースコードの依存関係を加えてアクセスできるようにする代わりに、外部の依存関係を使用します。
レポート送信時に発生する可能性があるメモリリークの修正など、バックポートされていないバグ修正がいくつかあります。
```
AsyncUnityUserReportingPlatform
```
が削除されました。
サンプルのプレハブ GUI がディスプレイに合わせて拡大縮小されるようになりました。

古い SDK の古い要素はサポート対象と見なされなくなりました。

SimpleJSON

パーサーなどのヘルパーに依存している場合は引き続き使用できますが、代替手段に置き換えることを強くお勧めします。Unity は、以前のバージョンの SDK のそうした要素を維持またはサポートしません。プロジェクトの新機能で古い SDK ヘルパーに依存すること (

PngHelper

の使用など) を検討している場合は、古い SDK に依存するのではなく代替手段を探ることをお勧めします。 User Reporting API は User Reporting 関連の機能に特化しており、将来の API 離脱を防ぐのに役立ちます。また、Unity が SDK の User Reporting の側面に限定して有意義なサポートと改善を提供するのにも役立ちます。

新しいプレハブの例の使用

古いバージョンの SDK に含まれていた出発点となる例が、更新されて置き換えられました。これは同じエンドユーザー機能を提供し、シーン内で置き換え可能です。

レポートの作成

ユーザーレポートオブジェクトが手作業で作成されなくなりました。代わりに、1 度に 1 件のレポートを作成して送信できます。作成中のレポートは “進行中” のレポートと呼ばれます。新しいユーザーレポートを作成する場合は、以前の進行中のレポートが消去されます (以前のレポートが存在する場合)。

UserReportingService.Instance.CreateNewUserReport();

一度に複数のレポート用のデータを収集して配置したい場合は、データに対する責任を管理し、送信の準備ができたら最終的にそのデータをレポートにエクスポートする必要があります。

レポートの送信

SDK は一度に 1 件のレポートのみを処理するようになりました。送信メソッドに UserReport オブジェクトを提供する代わりに、API では進行中のレポートを送信するための 1 つの呼び出し

UserReportingService.Instance.SendUserReport(...)

が提供されます。さらに、1 つのコールバックの代わりに、進行中のレポートで 2 つの異なるオプションコールバックが提供されるようになりました。1 つは送信の進行状況の更新用で、もう 1 つはレポート送信の試行が完了したときのためのものです。


UserReportingService.Instance.SendUserReport((uploadProgress) =>{	// The progressUpdate Action uses the uploadProgress float to indicate progress from 0.0 -> 1.0	Debug.Log("${uploadProgress:P}");},(success) =>{	// The result Action uses the success bool to indicate whether or not the submission succeeded	if (!success)	{		Debug.Log("Failed to send report!");	}});

データの追加に対する全般的な変更点

個々のレポートオブジェクトのリストに個々のオブジェクト値を追加する場合、過去に使用されていたコンストラクタと同じ引数を持つ特殊な関数が使用され、すべての場所に適用されます。以下の例を参照してください。ここでは新しいレポートディメンションを追加しています。 1.0 新しいレポートディメンションを追加する例:


UserReport current;UnityUserReporting.CurrentClient.CreateUserReport((report) => {	current = report;});current.Dimensions.Add(new UserReportNamedValue("Category", “Value”));

2.0 新しいレポートディメンションを追加する例:

UserReportingService.Instance.AddDimensionValue("Category", “Value”);

カスタム添付ファイルの追加

ユーザーレポートオブジェクト自体に直接添付ファイルを追加する代わりに、進行中のレポートに添付ファイルを追加するための関数が SDK で提供されるようになりました。


string content = "{}"; // An empty JSON object for example purposes.UserReportingService.Instance.AddAttachmentToReport("Sample Attachment JSON", "SampleAttachment.json", Encoding.UTF8.GetBytes(content), "application/json");

(デバイス) メタデータの追加 “デバイスメタデータ” という呼称は、メタデータに一般化されました。この目的のための関数も提供されるようになりました。

UserReportingService.Instance.AddMetadata(“Example Name”, “Example Value”)

結論

このドキュメントの執筆時点では、User Reporting ダッシュボードに対する変更はありません。最新バージョンの SDK にアップグレードする際に、User Reporting の公式ドキュメントを参照してください。

ドキュメント

Development

User Acquisition

Monetization

産業