ISiteLicenseService Interface (Steamworks-dokumentasjon)

Steamworks-dokumentasjon

ISiteLicenseService Interface

Provides access to services related to operating sites which are part of the Steam PC Cafe program.

GetCurrentClientConnections

GET https://api.steampowered.com/ISiteLicenseService/GetCurrentClientConnections/v1/

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key
siteid	uint64		Site ID to see; zero for all sites

See current activity at one or more sites.

The response has the following structure:

Name	Type	Description
sites	see below	A list of site details
game_names	see below	Mapped list of game names.

game_names has the following structure:

Name	Type	Description
id	uint32	ID number of entry; referenced in site info below
name	string	Game name

sites has the following structure:

Name	Type	Description
siteid	uint64	64-bit SiteID of the site
site_name	string	Site name you have assigned to the site
clients	see below	list of active clients at the site

clients has the following structure:

Name	Type	Description
ip_address	string	IP address of client computer
hostname	string	machine name of client computer
games	see below	list of active game sessions on the client computer

games has the following structure:

Name	Type	Description
id	uint32	ID of game in the `game_names` section of the response
start_time	string	time this game session started (RFC 3339 UTC format)
license_type	string	see below

license_type may have one of the following values:

Value	Description
user	The user owns a license for the game
commercial	The user is playing via a paid commercial license applied to the site
free	The user is playing via a free commercial license applied to the site

GET https://api.steampowered.com/ISiteLicenseService/GetTotalPlaytime/v1/

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key
start_time	string	✔	Report activity starting on or after this time. RFC 3339 UTC format.
end_time	string	✔	Report activity starting before this time. RFC 3339 UTC format.
siteid	uint64		Site ID to see; zero for all sites

Get total playtime amounts for all games over a period of time; for one or all sites.

The response has the following structure:

Name	Type	Description
sites	see below	A list of site details
game_names	see below	Mapped list of game names.

game_names has the following structure:

Name	Type	Description
id	uint32	ID number of entry; referenced in site info below
name	string	Game name

sites has the following structure:

Name	Type	Description
siteid	uint64	64-bit SiteID of the site
site_name	string	Site name you have assigned to the site
games	see below	list of all game titles played

games has the following structure:

Name	Type	Description
id	uint32	ID of game in the `game_names` section of the response
license_type	string	Playtime is divided up for each game by the type of license used. See the GetCurrentClientConnections section above for the list.
playtime_seconds	uint32	total playtime for this game and license type, in seconds, for the requested period.