Amazon Pinpoint からのアプリケーションイベントデータストリーム

アプリケーション (アプリ) を Amazon Pinpoint と統合してイベントストリーミングを設定すると、Amazon Pinpoint はセットアップ時に指定した送信先からアプリケーションのユーザーアクティビティ、カスタムイベント、およびメッセージ配信データを取得して表示します。イベントデータを表示できるようにイベントストリーミングを設定する方法については、「 Amazon Kinesis または Amazon Data Firehose を介してアプリイベントデータをストリーミングするように Amazon Pinpoint を設定する 」を参照してください。

アプリケーションイベントの例

アプリイベントの JSON オブジェクトには以下の例に示されているデータが含まれています。

{
  "event_type": "_session.stop",
  "event_timestamp": 1487973802507,
  "arrival_timestamp": 1487973803515,
  "event_version": "3.0",
  "application": {
    "app_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "cognito_identity_pool_id": "us-east-1:a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    "package_name": "main.page",
    "sdk": {
      "name": "aws-sdk-mobile-analytics-js",
      "version": "0.9.1:2.4.8"
    },
    "title": "title",
    "version_name": "1.0",
    "version_code": "1"
  },
  "client": {
    "client_id": "m3n4o5p6-a1b2-c3d4-e5f6-g7h8i9j0k1l2",
    "cognito_id": "us-east-1:i9j0k1l2-m3n4-o5p6-a1b2-c3d4e5f6g7h8"
  },
  "device": {
    "locale": {
      "code": "en_US",
      "country": "US",
      "language": "en"
    },
    "make": "generic web browser",
    "model": "Unknown",
    "platform": {
      "name": "android",
      "version": "10.10"
    }
  },
  "session": {
    "session_id": "f549dea9-1090-945d-c3d1-e4967example",
    "start_timestamp": 1487973202531,
    "stop_timestamp": 1487973802507
  },
  "attributes": {},
  "metrics": {}
}

アプリイベントの属性

このセクションでは、前の例のアプリケーションイベントストリームに含まれる属性を定義します。

属性	説明
event_type	イベントのタイプ。可能な値は以下のとおりです。 _session.start – エンドポイントが新しいセッションを開始しました。 _session.stop – エンドポイントがセッションを終了しました。 _userauth.sign_in – アプリケーションにログインしているエンドポイント。 _userauth.sign_up – 新しいエンドポイントがアプリケーションの登録プロセスを完了しました。 _userauth.auth_fail – エンドポイントがアプリケーションにサインインしようとしましたが、プロセスを完了できませんでした。 _monetization.purchase – エンドポイントがアプリケーションで購入されました。 _session.pause – エンドポイントはセッションを一時停止しました。一時停止したセッションは再開できるため、まったく新しいセッションを開始しなくてもメトリクスの収集を継続できます。 _session.resume – エンドポイントはセッションを再開しました。
event_timestamp	イベントが報告された時刻。Unix 時間 (ミリ秒単位) として表示されます。
arrival_timestamp	イベントが Amazon Pinpoint によって受信された時刻が、Unix 時間 (ミリ秒単位) として表示されます。
event_version	イベントの JSON スキーマのバージョン。 ヒント イベント処理アプリケーションでこのバージョンをチェックし、スキーマの更新に合わせてアプリケーションを更新する時期を把握します。
application	イベントに関連付けられた Amazon Pinpoint プロジェクトに関する情報。詳細については、表「アプリケーション」を参照してください。
client	イベントを報告したエンドポイントに関する情報。詳細については、表「クライアント」を参照してください。
device	イベントを報告したデバイスに関する情報。詳細については、表「デバイス」を参照してください。
session	イベントを生成したセッションに関する情報。詳細については、表「セッション」を参照してください。
attributes	イベントに関連付けられている属性。アプリケーションによって報告されるイベントの場合、このオブジェクトにはユーザーが定義したカスタム属性が含まれます。
metrics	イベントに関連するメトリクス。オプションで、カスタムメトリクスを Amazon Pinpoint に送信するようにアプリケーションを設定できます。

アプリケーション

イベントが関連付けられている Amazon Pinpoint プロジェクトに関する情報が含まれています。

属性	説明
app_id	イベントを報告した Amazon Pinpoint プロジェクトの一意の ID。
cognito_identity_pool_id	エンドポイントが関連付けられている Amazon Cognito ID プールの ID。
package_name	アプリパッケージの名前 (com.example.my_app など)。
sdk	イベントを報告するために使用された SDK に関する情報。詳細については、表「SDK」を参照してください。
title	アプリケーションの名前。
version_name	アプリケーションのバージョンの名前 (V2.5 など)。
version_code	アプリケーションのバージョン番号 (3 など)。

SDK

イベントを報告するために使用された SDK に関する情報を含めます。

属性	説明
name	イベントを報告するために使用された SDK の名前。
version	SDK のバージョン。

クライアント

イベントを生成したエンドポイントに関する情報が含まれています。

属性	説明
client_id	エンドポイントの ID。
cognito_id	エンドポイントに関連付けられている Amazon Cognito ID トークン。

デバイス

イベントを生成したエンドポイントのデバイスに関する情報が含まれています。

属性	説明
locale	エンドポイントのデバイスの言語とリージョンの設定に関する情報。詳細については、表「ロケール」を参照してください。
make	エンドポイントのデバイスの製造元。
model	エンドポイントのデバイスのモデル識別子。
platform	エンドポイントのデバイス上のオペレーティングシステムに関する情報。詳細については、表「プラットフォーム」を参照してください。

[Locale] (国)

エンドポイントのデバイスの言語とリージョンの設定に関する情報を含めます。

属性	説明
code	デバイスに関連付けられているロケール識別子。
country	デバイスのロケールに関連付けられている国またはリージョン。
language	デバイスのロケールに関連付けられている言語。

プラットフォーム

エンドポイントのデバイス上のオペレーティングシステムに関する情報を含めます。

属性	説明
name	デバイス上のオペレーティングシステムの名前。
version	デバイス上のオペレーティングシステムのバージョン。

セッション

イベントを生成したセッションに関する情報が含まれています。

属性	説明
session_id	セッションを識別する一意の ID。
start_timestamp	セッションが開始された日時。Unix 時間 (ミリ秒単位) として表示されます。
stop_timestamp	セッションが終了した日時。Unix 時間 (ミリ秒単位) として表示されます。