コンソールAPIリファレンスのテスト[ベータ]

フォローする
Avatar
Dora Kishinevsky
Updated

テストコンソールAPIは、Singularアプリのテストコンソールページに代わるものです。どちらのツールも、お使いのデバイス（アプリをインストールした登録済みのテストデバイス）からSingularサーバーにどのようなデータが送信されているかを表示することで、Singular SDKやS2Sの統合をテスト することができます。

Singular SDK/S2Sがあなたのアプリに正しく統合されていれば、デバイスはあなたが実装した全てのプロパティでユーザーセッションとイベントをSingularに送信しているはずです。

詳しくは

クイックスタートガイド

1 Register Device Endpointを呼び出し、テストデバイスを登録します。
2 5秒待ってから「Check Device Registration（デバイス登録の確認）」を呼び出し、デバイスが登録され、ログに記録する準備ができているかどうかを確認します。
3

デバイスをログに記録する準備ができたら、デバイスを使用して、テストしたいアプリイベントを実行します。 SDK/S2S統合のさまざまな機能をテストする方法の詳細については、Singular SDK統合をテストする方法を参照してください。

注意事項
  • ログには最大100件のイベントが表示されます。テストするイベントが100を超える場合は、ログを複数回取得する必要があります。
  • デバイス登録の有効期限は1時間です。イベントの実行にさらに時間が必要な場合は、再度デバイスの登録を呼び出してください（APIの制約と制限を参照）。
4 デバイスがSingularに何を送信したかを確認するために、ログの取得エンドポイントを呼び出します。
5 オプションで、デバイスの登録解除を呼び出します。呼び出さない場合、デバイスの登録は、デバイスの登録呼び出しから1時間経過すると自動的に失効します。

APIエンドポイントリファレンス

デバイス登録エンドポイント

POST api.singular.net/api/event_logger/device

使用法

このエンドポイントを使用して、新しいロギング・セッションを開始するためにデバイスを登録します。 ロギング・セッションは、1 時間後に自動的に失効します。

サンプル呼び出し

POST 'https://api.singular.net/api/event_logger/device?api_key=<api-key>'
  
  Request body:
  {
      "device_id": "058000d94-1972-448b-8c08-32c0ccc81fa4",
      "keyspace": "AIFA",
      "platform": "Android"
  }

クエリーパラメーター

パラメータ 必要ですか？ 説明
api_key 必須（認証ヘッダーで渡されていない場合） Singular APIキーを取得するには、Singularアカウントにログインし、設定 > APIに進みます。キーを表示]をクリックし、[キーをコピー]をクリックします。
device_id 必須 登録するテストデバイスのID (例: 058000d94-1972-448b-8c08-32c0ccc81fa4)
keyspace 必須 デバイスIDの種類（例：AIFA
platform 必須 デバイス・プラットフォーム（例：Android

期待されるレスポンス

注意: レスポンスが登録成功（ステータス 200）を示していても、コンソールはまだイベントを記録する準備ができていない可能性があります。1秒待ってから "Check Device Registration "エンドポイントを呼び出すことをお勧めします。

{
      "status": 0, 
      "log_session_info":
          {
              "session_expire_timestamp": 1647448055, 
              "session_start_timestamp": 1647444455,
              "session_id": "eceece6f-ef54-4f1a-8fe9-d3da1563c05a"
          },
      "registered_devices_num": 2
  }

デバイス登録確認エンドポイント

GET api.singular.net/api/event_logger/device

使用法

このエンドポイントを使用して、指定されたデバイスがテスト コンソールに登録されているかどうかを確認します。 デバイスが登録され、ロガーがデバイスからの情報収集を開始する準備ができている場合、デバイス上のアプリでイベントの実行を開始し、それらをテストできます。

クエリ パラメータ

パラメータ 必須か？ 説明
api_key 必須（認可ヘッダーで渡されていない場合） Singular APIキーを取得するには、Singularアカウントにログインし、設定 > APIに進みます。キーを表示]をクリックし、[キーをコピー]をクリックします。
device_id 必須 登録したデバイスのID (例: 058000d94-1972-448b-8c08-32c0ccc81fa4)
keyspace 必須 指定したデバイスIDの種類（例：AIFA
platform 必須 デバイスのプラットフォーム（例：Android

可能なレスポンス

レスポンス 意味 
HTTP 200
  
  {
      “status”:0,
      “message”: “Device registered”,
      “log_session_info”: [session_id, session_start_timestamp, session_expire_timestamp]
  }
 デバイスは登録されており、コンソールはデバイスからのイベントのログを開始する準備ができています。 
HTTP 307
              
  Header: Retry After <delay seconds>
          
  {
      “status”:1,
      “session_id”,
      “message”:”Device registration
        in progress, retry after 
         x seconds”
  }
 デバイスは登録されているが、コンソールがイベントのログを記録する準備ができていない。 必要な秒数待ってから、再度確認してください。 
HTTP 404
              
  {
      “status”:”3”,
      "message”:”Device not registered”
  }
 デバイスが登録されていないか、登録がタイムアウトしています。 デバイスの登録エンドポイントを再度呼び出してください。

ログ取得エンドポイント

GET api.singular.net/api/event_logger/retrieve_logs

使用法

このエンドポイントを使用して、現在のセッションで、デバイスに対して記録されたすべての Singular イベントを取得します。

クエリ・パラメータ

パラメータ 必須か？ 説明
api_key 必須（認可ヘッダで渡されない場合） Singular APIキーを取得するには、Singularアカウントにログインし、設定 > APIに進みます。キーを表示]をクリックし、[キーをコピー]をクリックします。
device_id 必須 テストするデバイスのID (例: 058000d94-1972-448b-8c08-32c0ccc81fa4)
keyspace 必須 デバイスIDの種類（例：AIFA
platform 必須 デバイス・プラットフォーム（例：Android

クエリー・レスポンス

Success: HTTP 200 
  
  {
      “status”:0,
      “Message”:”Request OK”
      “log_session_info”: [session_id, session_start_timestamp, session_expire_timestamp]
      “event_details”: [payload]
  }

デバイス・エンドポイントの登録解除

DELETE api.singular.net/api/event_logger/event_logger/device

使用方法

登録されたデバイスのロギング・セッションを停止するには、このエンドポイントを使用します。

クエリーパラメーター

パラメータ 必須か？ 説明
api_key 必須（認可ヘッダで渡されていない場合） Singular APIキーを取得するには、Singularアカウントにログインし、設定 > APIに進みます。キーを表示]をクリックし、[キーをコピー]をクリックします。
device_id 必須 登録したデバイスのID (例: 058000d94-1972-448b-8c08-32c0ccc81fa4)
device_id_type 必須 指定したデバイスIDの種類（例：AIFA
platform 必須 デバイスのプラットフォーム（例：Android

 

可能なレスポンス

Success: HTTP 200
  
  {
      “status”:0,
      “message”:”Device unregistered”
      “open_sessions_num”,
      “log_session_info”: [session_id, session_start_timestamp, session_expire_timestamp]
  }
Error: HTTP 400
  
  {
      “status”:”1”, 
      “message”:”Invalid request, check required fields”
  }
HTTP 204
  
  {
      “status”:”2”, 
      “message”:”Device not registered”
  }

APIの制約と制限

APIには、各クライアント（api-key）に対して以下の制限があります：

  1. 各ロギング・セッションは1時間後に期限切れとなり、その後、ロギング・セッションのイベントのデータはすべて削除され、新しいデータは追跡されません。 セッションの期限切れを1時間遅らせるために、すでに登録されているデバイスに再度デバイス登録リクエストを送信することができます。
  2. apiキー1つにつき、一度に50のオープン・ロギング・セッション（50デバイス分）しか存在できません。デバイスの登録]リクエストと[デバイスの登録解除]リクエストに成功すると、open_sessions_numが送信され、開いているセッションの数を監視するのに役立ちます。
  3. デバイスごとの最大ログ・イベント数は100です。制限に達すると、新しいイベントのためのスペースを確保するために、古いイベントがログから削除されます。
  4. APIは、毎秒最大20リクエストを受け取ることができます。