ゲーム通知とのやり取りに使用するインターフェイスです。
注: これはサービスインターフェイスです。このインターフェイスのメソッドは
input_json
パラメーターで呼び出す必要があります。
Steamworks Web APIの使用に関する詳細は、
Web API 概要を参照してください。
CreateSession
POST https://partner.steam-api.com/IGameNotificationsService/CreateSession/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
appid | uint32 | ✔ | セッションを作成するApp ID |
context | uint64 | ✔ | セッションをバックエンドのオブジェクトに関連付けるためにゲームが使用できるゲーム指定のコンテキスト値。 |
title | {message} | ✔ | 各ユーザーのセッションのリスト内に表示されるセッションのタイトル。 |
users | {message} | ✔ | セッション内のすべてのユーザーの初期状態。 |
steamid | uint64 | | (オプション)代わりにリクエストを行うSteam ID。指定した場合、そのユーザーは必ずセッションに参加している必要があり、セッションに追加される全ユーザーは、そのユーザーとフレンドである必要があります。 |
リクエストで指定したプレイヤーとの新しい非同期セッションを作成します。
このAPI呼び出しで返される一意のセッションは、Game Notifications APIの他の呼び出しを参照するために使用されるため、ゲームのセッション状態と合わせて保存される必要があります。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
応答の例:{
"response": {
"sessionid": "10"
}
}
呼び出しの例:{
"context": "31415926"
"title":
{
"token": "#MyToken",
"variables":
[
{ "key": "username", "value": "SteamUser" }
]
},
"users":
[
{
"steamid": "76561197960265729",
"state": "waiting",
"title":
{
"token": "#TitleToken",
"variables":
[
{ "key": "username", "value": "Bob" }
{ "key": "level", "value": "1" }
]
},
"message":
{
"token": "#StatusMessageToken",
"variables":
[
{ "key": "city", "value": "Bellevue" }
]
}
}
]
}
UpdateSession
POST https://partner.steam-api.com/IGameNotificationsService/UpdateSession/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
sessionid | uint64 | ✔ | 更新するsessionid。 |
appid | uint32 | ✔ | 更新するセッションのApp ID。 |
title | {message} | ✔ | (オプション)セッションの新しいタイトル。 指定しない場合、タイトルは変更されません。 |
users | {message} | ✔ | (オプション)指定した状態を反映し、状態が更新されるユーザーのリスト。 ユーザーがセッション内にいない場合、追加されます。 |
steamid | uint64 | ✔ | (オプション)代わりにリクエストを行うSteam ID。指定された場合、ユーザーはセッションに参加している必要があります。 |
ゲームの状態が変化するたびに、ゲームセッションを更新します。
ここで送信される内容は、ゲーム内のすべてのユーザーに対するユーザー通知に反映されるため、必ず各ユーザーの状態を更新してください。 指定されていないセッション内のユーザーはセッションから削除され、新しく指定されたユーザーはセッションに追加されます。 セッションの完了状態を送信する必要があります-以前の状態はすべて、新しく指定された状態に置き換えられます。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
応答の例:{
"response": {
}
}
呼び出しの例:{
"sessionid": "1234",
"title":
{
"token": "#MyToken",
"variables":
[
{ "key": "username", "value": "SteamUser" }
]
},
"users":
[
{
"steamid": "76561197960265729",
"state": "waiting",
"title":
{
"token": "#TitleToken",
"variables":
[
{ "key": "username", "value": "Bob" }
{ "key": "level", "value": "1" }
]
},
"message":
{
"token": "#StatusMessageToken",
"variables":
[
{ "key": "city", "value": "Bellevue" }
]
}
},
{
"steamid": "76561197960265730",
"state": "waiting",
"title":
{
"token": "#TitleToken",
"variables":
[
{ "key": "username", "value": "Greg" }
{ "key": "level", "value": "2" }
]
},
"message":
{
"token": "#StatusMessageToken",
"variables":
[
{ "key": "city", "value": "Seattle" }
]
}
}
]
}
EnumerateSessionsForApp
GET https://partner.steam-api.com/IGameNotificationsService/EnumerateSessionsForApp/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
appid | uint32 | ✔ | 詳細をリクエストするセッションID。 オプションです。 指定しない場合、すべてのユーザーのセッションが返されます。 |
steamid | uint64 | ✔ | セッションを列挙するユーザー。 |
include_all_user_messages | bool | ✔ | (オプション)すべてのユーザー用のメッセージを含むかどうかを設定します。 デフォルトはfalseです。 |
include_auth_user_message | bool | ✔ | (オプション)認証されたユーザー用のメッセージを含むかどうかを設定します。 デフォルトはfalseです。 |
language | string | ✔ | (オプション)テキストをローカライズする言語。 |
これはSteam IDが含まれるセッションのリストを返します。
オプションのboolは、設定されている場合、各セッションに関する詳細を返します。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
応答の例:{
"response": {
[
{
"sessionid": "123",
"appid": "100",
"title":
{
"token": "#TitleToken",
"variables":
[
{ "key": "keyName", "value": "keyValue" }
]
},
"time_created": "100000", // Unix time
"time_updated": "200000", //Unix time
"user_status":
[
{
"steamid": "76561197960265729",
"state": "waiting",
"title":
{
"token": "#TitleToken",
"variables":
[
{ "key": "username", "value": "Bob" }
{ "key": "level", "value": "1" }
]
},
"message":
{
"token": "#StatusMessageToken",
"variables":
[
{ "key": "city", "value": "Bellevue" }
]
}
},
{
"steamid": "76561197960265730",
"state": "waiting",
"title":
{
"token": "#TitleToken",
"variables":
[
{ "key": "username", "value": "Greg" }
{ "key": "level", "value": "2" }
]
},
"message":
{
"token": "#StatusMessageToken",
"variables":
[
{ "key": "city", "value": "Seattle" }
]
}
}
]
}
}
呼び出しの例:{
"steamid": "76561197960265729",
"include_all_user_messages": "0",
"include_auth_user_message": "1"
}
GetSessionDetailsForApp
GET https://partner.steam-api.com/IGameNotificationsService/GetSessionDetailsForApp/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
sessions | {message} | ✔ | 詳細を受け取るセッション |
appid | uint32 | ✔ | セッションのappid。 |
language | string | ✔ | テキストをローカライズする言語。 |
特定のセッションに関する詳細を返します。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
応答の例:{
"response": {
[
{
"sessionid": "12",
"appid": "100",
"title":
{
"token": "#TitleToken",
"variables":
[
{ "key": "keyName", "value": "keyValue" }
]
},
"time_created": "100000", // Unix time
"time_updated": "200000", //Unix time
"user_status":
[
{
"steamid": "76561197960265729",
"state": "waiting",
"title":
{
"token": "#TitleToken",
"variables":
[
{ "key": "username", "value": "Bob" }
{ "key": "level", "value": "1" }
]
},
"message":
{
"token": "#StatusMessageToken",
"variables":
[
{ "key": "city", "value": "Bellevue" }
]
}
},
{
"steamid": "76561197960265730",
"state": "waiting",
"title":
{
"token": "#TitleToken",
"variables":
[
{ "key": "username", "value": "Greg" }
{ "key": "level", "value": "2" }
]
},
"message":
{
"token": "#StatusMessageToken",
"variables":
[
{ "key": "city", "value": "Seattle" }
]
}
}
]
}
}
呼び出しの例:{
"sessions":
[
{
"sessionid": "12",
"include_all_user_messages": "0"
},
{
"sessionid": "13",
"include_all_user_messages": "0"
}
]
}
RequestNotifications
POST https://partner.steam-api.com/IGameNotificationsService/RequestNotifications/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
steamid | uint64 | ✔ | 通知をリクエストするSteam ID。 |
appid | uint32 | ✔ | 通知をリクエストするApp ID。 |
ユーザーがアプリ用にゲーム通知を受け取るようリクエストします。
ユーザーがゲーム通知を必要とするゲームを開始するたびに、サーバーはログインしているユーザーに対して、RequestNotificationsを呼び出す必要があります。 これは、特定のゲームでゲーム通知にオプトインするようにユーザーに求めることで、ゲームがユーザーへオフライン通知を使用するように登録します。 この呼び出しは、ゲームの起動ごとに1度だけ行ってください。 ユーザーがオプトアウトした場合、それ以降の呼び出しがユーザーにオプトインを求めることはありません。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
応答の例:{
"response": {
}
}
呼び出しの例:{
"steamid": "76561197960265729",
"appid": 480
}
DeleteSession
POST https://partner.steam-api.com/IGameNotificationsService/DeleteSession/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
sessionid | uint64 | ✔ | 削除するsessionid。 |
appid | uint32 | ✔ | 削除するセッションのApp ID。 |
steamid | uint64 | ✔ | (オプション)代わりにリクエストを行うSteam ID。指定した場合、ユーザーはセッションに参加している必要があります。 |
アクティブな非同期ゲームセッションを削除します。 これはゲームセッションに参加しているすべてのユーザーへの全通知を削除します。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
応答の例:{
"response": {
}
}
呼び出しの例:{
"sessionid": "10"
}
DeleteSessionBatch
POST https://partner.steam-api.com/IGameNotificationsService/DeleteSessionBatch/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
sessionid | uint64 | ✔ | 削除するsessionid。 |
appid | uint32 | ✔ | 削除するセッションのappid。 |
非同期ゲームセッションのバッチを削除します
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!