PC & Console Server-to-Server (S2S) API エンドポイントリファレンス

ドキュメント
PCおよびコンソールゲームのアトリビューションはエンタープライズ機能です。この機能の詳細については、PCおよびコンソールゲームのアトリビューションに関するFAQをお読みいただくか、カスタマー・サクセス・マネージャーまでお問い合わせください。

セッション通知エンドポイント

GET https://s2s.singular.net/api/v1/launch

セッション通知エンドポイントを使用して、このエンドポイントにすべてのゲーム起動(初回セッション、リピートセッション)を可能な限りリアルタイムで報告します。 SingularデバイスIDで識別されるインストールに対してSingularが受信した最初のゲーム起動がアトリビューションに使用されます。

セッションパラメータ

パラメータ 説明 制約
a あなたのSingularアカウントの "SDK "キー。"Developer Tools -> SDK Integration > SDK Keys "にあります。 必須 あなたの組織名_sh868sdjv
p ゲームのプラットフォーム:
PC、Xbox、プレイステーション、任天堂、メタクエスト

必須

サポートされる値のみ

pc
i ゲームに固有のゲーム識別子値。 同じゲームを複数のプラットフォームで配布する場合は、同じ値を使用します。

必須

逆DNS表記

大文字と小文字を区別

com.singular.game
sdid

Singularがユーザーの固有のインストールとゲームアクティビティを識別するために使用するSingularデバイスID。

このUUIDはゲーム/サーバーが生成する必要があり、最初のゲーム起動(インストール)時に生成することを推奨します。

UUID(バージョン4) 49c2d3a6-326e-4ec5-a16b-0a47e34ed953
マッチID

アトリビューションに使用できる識別子で、ユーザーの最初のゲーム起動時に送信する必要があります。この値はSingular web SDKの実装で使用されている "match_id "と一致する必要があります。

識別子がPIIの場合、ハッシュ化(SHA-256)されていなければならない。

決定論的帰属のためのオプション

送信される場合は、インストール後の最初のゲーム起動時でなければなりません。

matchid_12345
OS

オペレーティングシステム / ゲームシステム

カスタム値もサポートされていますが、推奨値があります。

必須

サポートされるカスタム値

プラットフォーム = PC

  • ウィンドウズ
  • リナックス
  • macOS
  • スチームOS

プラットフォーム = XBox

  • Xbox_one
  • Xbox_360
  • Xbox_series_s
  • Xbox_series_x

プラットフォーム = プレイステーション

  • プレイステーション3
  • プレイステーション4
  • プレイステーション5

プラットフォーム = 任天堂

  • ニンテンドースイッチ

プラットフォーム = メタクエスト

  • メタクエスト
  • メタクエスト2
  • メタクエストプロ
VE オペレーティングシステムのバージョン オプション 22H2
av アプリのバージョンまたはゲームのビルド オプション 1.1.5.581823a
IP

ゲーム起動イベント時のデバイスのIP

必須 172.58.29.235
使用IP HTTPリクエストからIPフィールドを抽出します。これをtrueに設定した場合は、ipパラメータを提供しません。

オプション

ブール値

false
インストールソース

ゲームを配布したゲームストアの名前。

カスタム値もサポートされていますが、推奨値です。

必須

スチーム

epicgamestore

マイクロソフトストア

gog

ハンブルストア

Xbox

プレイステーション

任天堂

自主流通

[カスタム]

ua デバイスのユーザーエージェント オプション

Mozilla/5.0 (Windows NT 10.0; Win64; x64)
AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0 Safari/537.36

グローバルプロパティ

ユーザーのために定義し、保存することができるキーと値のペア。定義された値は、それ以降のすべての呼び出しで永続化されなければなりません。値を送信しないことは、値の設定を解除したとみなされます。

オプション

最大 5 つのグローバル・プロパティがサポートされます。各プロパティの長さは 200 文字です。 URLEncoded JSON オブジェクトである必要があります。

%7B%22key1%22%3A%22value1%22%2C%
22key2%22%3A%22value2%22%7D

データ共有オプション

情報を共有することに対するエンドユーザーの同意を示すために、このオプション値を渡します。設定された場合、この値は永続化され、そのユーザーの後続の/launchおよび/evtリクエストごとに渡される必要があります。PC & コンソール・ユーザーのプライバシー」を参照。

limit_data_sharing":falseを渡すと、ユーザーが情報共有に同意した(オプトインした)ことを示します。

ユーザーが拒否した場合は、"limit_data_sharing":trueを渡す。

オプション

%7B%22limit_data_sharing%22%3Atrue%7D

インストール インストール・フラグ。セッションがアプリのインストール後の最初のものである場合は 'true'。そうでない場合は 'false'。再インストール・トラッキング機能に必要です。

オプション

ブール値

true
時間 UNIX時間でのゲーム起動時間。 任意 1483228800
ミリ秒 UNIX時間での対局開始時間(ミリ秒)。 任意 1483228800000
カスタムユーザーID

ユーザーID

任意 123456789abcd

イベント通知エンドポイント

GET https://s2s.singular.net/api/v1/evt

イベント通知エンドポイントを使用して、希望するすべてのゲーム内イベントを可能な限りリアルタイムに近い状態でこのエンドポイントに報告します。ゲーム内イベントを渡すことは非常に推奨され、分析、レポート、最適化のための様々なパートナーへの転送に使用されます。

イベントパラメータ

パラメータ 説明 制約
a あなたのSingularアカウントの "SDK "キー。"Developer Tools -> SDK Integration > SDK Keys "にあります。 必須 あなたの組織名_sh868sdjv
p ゲームのプラットフォーム:
PC、Xbox、プレイステーション、任天堂、メタクエスト

必須

サポートされる値のみ

pc
i ゲームに固有のゲーム識別子値。 同じゲームを複数のプラットフォームで配布する場合は、同じ値を使用します。

必須

逆DNS表記

大文字と小文字を区別

com.singular.app
sdid

Singularがユーザーの固有のインストールとゲームアクティビティを識別するために使用するSingularデバイスID。

このUUIDはゲーム/サーバーが生成する必要があり、最初のゲーム起動(インストール)時に生成することを推奨します。

UUID 49c2d3a6-326e-4ec5-a16b-0a47e34ed953
n

ゲーム内イベントの名前。

Singularの標準イベント命名規則を使用することを強く推奨します。

必須 sng_achievement_unlocked
e

イベントに関する豊富な情報を提供するJSON形式のカスタムイベント属性

Singularの標準イベント属性の命名規則を使うことを強く推奨します。

オプション

JSON

%7B%22sng_attr_content_id%22%3A5581%2C
sng_attr_content%22%3A%22XBox%22%2C%22
sng_attr_content_type%22%3A%22electronics%22%7D
is_revenue_event

収益イベントかどうか。イベント名が"__iap__"であるか、"amt "が0以外であれば省略可能。

収益イベントの場合は必須

true
amt

収益イベントの場合、通貨金額。これは "cur "パラメータと組み合わせて使用する必要があります。

収益イベントの場合は必須。

2.51
cur

収益イベントの場合、ISO-42173文字の通貨コード。これは "amt "パラメータと組み合わせて使用する。

収益イベントの場合は必須

EUR
os

オペレーティングシステム/ゲームシステム

カスタム値もサポートされていますが、推奨値は以下の通りです。

必須

サポートされるカスタム値

プラットフォーム = PC

  • ウィンドウズ
  • リナックス
  • macOS
  • スチームOS

プラットフォーム = XBox

  • Xbox_one
  • Xbox_360
  • Xbox_series_s
  • Xbox_series_x

プラットフォーム = プレイステーション

  • プレイステーション3
  • プレイステーション4
  • プレイステーション5

プラットフォーム = 任天堂

  • ニンテンドースイッチ

プラットフォーム = メタクエスト

  • メタクエスト
  • メタクエスト2
  • メタクエストプロ
VE オペレーティングシステムのバージョン オプション 22H2
av アプリのバージョンまたはゲームのビルド オプション 1.1.5.581823a
IP

ゲーム内イベント発生時のデバイスのIP

必須 172.58.29.235
使用IP HTTP リクエストから IP フィールドを抽出します。これを true に設定すると、ipパラメータを提供しません。

オプション

ブール値

false
インストールソース

ゲームを配布したゲームストアの名前。

カスタム値もサポートされていますが、推奨値です。

必須

スチーム

epicgamestore

マイクロソフトストア

gog

ハンブルストア

Xbox

プレイステーション

任天堂

自主流通

[カスタム]

ua デバイスのユーザーエージェント オプション

Mozilla/5.0 (Windows NT 10.0; Win64; x64)
AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0 Safari/537.36

グローバルプロパティ

ユーザーのために定義し、保存することができるキーと値のペア。定義された値は、それ以降のすべての呼び出しで永続化されなければなりません。値を送信しないことは、値の設定を解除したとみなされます。

オプション

最大 5 つのグローバル・プロパティがサポートされます。各プロパティの長さは 200 文字です。 URLEncoded JSON オブジェクトである必要があります。

%7B%22key1%22%3A%22value1%22%2C%
22key2%22%3A%22value2%22%7D

データ共有オプション

情報を共有することに対するエンドユーザーの同意を示すために、このオプション値を渡します。設定された場合、この値は永続化され、そのユーザーの後続の/launchおよび/evtリクエストごとに渡される必要があります。PCとコンソール・ユーザーのプライバシー参照

limit_data_sharing":falseを渡すと、ユーザーが情報共有に同意した(オプトインした)ことを示します。

ユーザーが拒否した場合は、"limit_data_sharing":trueを渡します。

オプション

%7B%22limit_data_sharing%22%3Atrue%7D

時間 UNIX時間でのゲーム内イベントの時間。 オプション 1483228800
umilisec ミリ秒単位のUNIX時間でのゲーム内イベントの時間。 任意 1483228800000
カスタムユーザーID

ユーザーID

任意 123456789abcd