Dient dem Zugriff auf Informationen zu und der Interaktion mit Benutzern.

Informationen zu zusätzlichen Methoden finden Sie unter IPlayerService.

Für weitere Informationen zur Verwendung der Steamworks-Web-API lesen Sie bitte den Dokumentationsartikel Web-API – Übersicht.

CheckAppOwnership

Name	Typ	Erforderlich?	Beschreibung
key	string	✔	Publisher-Authentifizierungsschlüssel der Steamworks-Web-API
steamid	uint64	✔	Steam-ID des Benutzers
appid	uint32	✔	App-ID zur Besitzüberprüfung.

Überprüft, ob der angegebene Benutzer die App besitzt.

Die JSON-Antwort enthält die folgenden Elemente:

Name	Typ	Beschreibung
ownsapp	bool	Gibt an, ob der Benutzer der tatsächliche Besitzer der Anwendung ist.
permanent	bool	Gibt an, ob der Benutzer Ihre Anwendung tatsächlich besitzt. Ist „false“, falls der Benutzer über die Familienbibliothek, an einem Gratiswochenende oder über das Steam-Café-Programm auf die Anwendung zugreift.
timestamp	string	Zeitpunkt, zu dem die Anwendung erworben wurde.
ownersteamid	uint64	Gibt den tatsächlichen Besitzer an, wenn der Benutzer auf diese Anwendung über die Familienbibliothek zugreift. Ansonsten wird die übergebene Steam-ID zurückgegeben.
sitelicense	bool	Gibt an, ob der Benutzer auf diese Lizenz über das Steam-Café-Programm zugreift.

Von dieser Methode existieren vorherige Versionen, die nicht mehr offiziell unterstützt werden. Sie sind zwar weiterhin verwendbar, aber es wird dringend empfohlen, die neueste Version zu verwenden.
Änderungsverlauf:

• Version 2 – Element sitelicense zur Antwort hinzugefügt.

HINWEIS: Dieser Aufruf erfordert den Publisher-API-Schlüssel, der die angegebene App-ID besitzt, um diese Methode verwenden zu verwenden. Daher MUSS diese API von einem gesicherten Server aufgerufen werden und kann nie direkt von Clients verwendet werden!

GetAppPriceInfo

Name	Typ	Erforderlich?	Beschreibung
key	string	✔	Publisher-Authentifizierungsschlüssel der Steamworks-Web-API
steamid	uint64	✔	Steam-ID des Benutzers
appids	string	✔	Durch Kommata getrennte Liste von App-IDs (max.: 100)

HINWEIS: Dieser Aufruf erfordert einen Publisher-API-Schlüssel, um diese Methode verwenden zu können. Daher MUSS diese API von einem gesicherten Server aufgerufen werden und kann nie direkt von Clients verwendet werden!

Example Response:

GetDeletedSteamIDs

Name	Typ	Erforderlich?	Beschreibung
key	string	✔	Publisher-Authentifizierungsschlüssel der Steamworks-Web-API
rowversion	uint64	✔	Ein vorzeichenloser 64-Bit-Wert zur Iteration von gelöschten Accounts. Übergeben Sie beim ersten Aufruf den Wert 0 und in allen folgenden Aufrufen den vom vorherigen Aufruf zurückgegebenen Wert. Dieser Wert muss für zukünftige Aufrufe auf Ihrem Server gespeichert werden.

Verwenden Sie GetDeletedSteamIDs, um eine Liste der gelöschten Accounts abzurufen, die Ihr(e) Spiel(e) vor der Löschung besaßen. Diese API wurde erstellt, um die Löschung von Nutzerdaten gemäß der DSGVO und anderer personenbezogener Daten zu ermöglichen.

Der bereitgestellte Steamworks-Publisher-Schlüssel wird sowohl zur Authentifizierung als auch zur Generierung der zu überprüfenden Liste der App-IDs verwendet.

GetFriendList

Name	Typ	Erforderlich?	Beschreibung
key	string	✔	Benutzer-Authentifizierungsschlüssel der Steamworks-Web-API
steamid	uint64	✔	Steam-ID des Benutzers
relationship	string		Beziehungstyp (z. B.: Freund)

GetPlayerBans

Name	Typ	Erforderlich?	Beschreibung
key	string	✔	Benutzer-Authentifizierungsschlüssel der Steamworks-Web-API.
steamids	string	✔	Durch Kommata getrennte Liste von Steam-IDs

GetPlayerSummaries

Name	Typ	Erforderlich?	Beschreibung
key	string	✔	Benutzer-Authentifizierungsschlüssel der Steamworks-Web-API
steamids	string	✔	Durch Kommata getrennte Liste von Steam-IDs (max.: 100)

HINWEIS: This call should only be used if your website needs to display information about a user. Wenn Ihr Spielclient jegliche dieser Informationen benötigt, verwenden Sie bitte stattdessen die Client-APIs.

Von dieser Methode existieren vorherige Versionen, die nicht mehr offiziell unterstützt werden. Sie sind zwar weiterhin verwendbar, aber es wird dringend empfohlen, die neueste Version zu verwenden.
Änderungsverlauf:

• Version 2: Elementnamen von Arrays entfernt.

The response from the call will look something like this:

GetPublisherAppOwnership

Name	Typ	Erforderlich?	Beschreibung
key	string	✔	Publisher-Authentifizierungsschlüssel der Steamworks-Web-API
steamid	uint64	✔	Steam-ID des Benutzers

Von dieser Methode existieren vorherige Versionen, die nicht mehr offiziell unterstützt werden. Sie sind zwar weiterhin verwendbar, aber es wird dringend empfohlen, die neueste Version zu verwenden.
Änderungsverlauf:

• Version 3: Element sitelicense zur Antwort hinzugefügt.

The response from the call will look something like this:


Die JSON-Antwort enthält die folgenden Elemente:

Name	Typ	Beschreibung
appid	uint32	App-ID, die mit Ihrem WebAPI-Schlüssel verbunden ist.
ownsapp	bool	Gibt an, ob der Benutzer Ihre Anwendung aktuell besitzt. Ist „true“, falls der Benutzer die Anwendung über den Kauf, einen Produktschlüssel, die Familienbibliothek, ein Gratiswochenende oder das Steam-Café-Programm besitzt.
permanent	bool	Gibt an, ob der Benutzer Ihre Anwendung tatsächlich besitzt. Ist „false“, falls der Benutzer die Anwendung über die Familienbibliothek, ein Gratiswochenende oder das Steam-Café-Programm besitzt.
timestamp	string	GMT-Zeit für den Zeitpunkt, zu dem der Benutzer die App-ID zum ersten Mal erworben hat
ownersteamid	uint64	Gibt den tatsächlichen Besitzer an, wenn der Benutzer auf diese Anwendung über die Familienbibliothek zugreift. Ansonsten wird übergebene Steam-ID zurückgegeben.
sitelicense	bool	Gibt an, ob der Benutzer auf diese Lizenz über das Steam-Café-Programm zugreift.

HINWEIS: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

GetPublisherAppOwnershipChanges

Name	Typ	Erforderlich?	Beschreibung
key	string	✔	Publisher-Authentifizierungsschlüssel der Steamworks-Web-API
packagerowversion	string	✔	Die 64-Bit-Zeilenversion ohne Vorzeichen, von der die Paketänderungen ausgelesen werden soll. Die Zeilenversion der bis dahin gelesenen Daten wird zur Verwendung in künftigen Aufrufen zurückgegeben.
cdkeyrowversion	string	✔	Die 64-Bit-Zeilenversion ohne Vorzeichen, von der die CD-Produktschlüsseländerungen ausgelesen werden soll. Die Zeilenversion der bis dahin gelesenen Daten wird zur Verwendung in künftigen Aufrufen zurückgegeben.

This method can be used to determine what SteamIDs have ownership changes starting from a particular package or key row version number. From the list of SteamIDs returned, a call to GetPublisherAppOwnership can then return the associated ownership data for the applications in the group associated with the key passed in. A partner may wish to track this data in conjunction with linked Steam Accounts to better understand the state of product ownership on Steam.

To begin, make a call to GetPublisherAppOwnershipChanges passing in packagerowversion and cdkeyrowversion with the values of 0 (zero). The response from the call will look something like this:


The JSON response will contain the following fields:

Name	Typ	Beschreibung
steamids/steamid	string	Die Liste von Steam-IDs für alle Accounts, die sich seit den bereitgestellten Zeilenversionen geändert haben. Pro Aufruf werden bis zu 10 000 Steam-IDs zurückgegeben.
packagerowversion	string	Die Paket-Zeilenversion, die mit der letzten zurückgegebenen Steam-ID übereinstimmt. Speichern Sie diese für zukünftige Aufrufe von GetPublisherAppOwnershipChanges.
cdkeyrowversion	string	Die Produktschlüssel-Zeilenversion, die mit der letzten zurückgegebenen Steam-ID übereinstimmt. Speichern Sie diese für zukünftige Aufrufe von GetPublisherAppOwnershipChanges.
moredata	bool	Gibt an, ob mehr und neuere Daten verfügbar sind.

After this first call returns:

1. Rufen Sie für jede Steam-ID GetPublisherAppOwnership auf, um das tatsächliche Besitzverhältnis für jede App-ID abzurufen. Speichern oder verwenden Sie diese Daten nach Bedarf.
   
2. Sobald alle Steam-IDs verarbeitet wurden, überprüfen Sie den Wert von moredata. Wenn dieser „true“ ist, rufen Sie GetPublisherAppOwnershipChanges erneut auf und übergeben Sie packagerowversion und cdkeyrowversion mit den Werten, die im vorigen Aufruf von GetPublisherAppOwnershipChanges zurückgegeben wurden.
   
3. Wiederholen Sie Schritt 1 und 2 solange, bis moredata „false“ zurückgibt.
   
4. Speichern Sie die letzten Werte von packagerowversion und cdkeyrowversion zur Verwendung für zukünftige Aufrufe von GetPublisherAppOwnershipChanges (z. B. 24 Stunden später), statt dann wieder bei 0 (null) zu beginnen.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

GetUserGroupList

Name	Typ	Erforderlich?	Beschreibung
key	string	✔	Publisher-Authentifizierungsschlüssel der Steamworks-Web-API
steamid	uint64	✔	Steam-ID des Benutzers

ResolveVanityURL

Name	Typ	Erforderlich?	Beschreibung
key	string	✔	Benutzer-Authentifizierungsschlüssel der Steamworks-Web-API
vanityurl	string	✔	Die Vanity-URL, für die eine Steam-ID abgerufen werden soll.
url_type	int32		Der Typ der Vanity-URL. 1 (Standard): Spielerprofil, 2: Gruppe, 3: Offizielle Spielgruppe.