REST Resource: players

Ressource: Player

Eine Spielerressource.

JSON-Darstellung
{
  "kind": string,
  "playerId": string,
  "displayName": string,
  "avatarImageUrl": string,
  "bannerUrlPortrait": string,
  "bannerUrlLandscape": string,
  "originalPlayerId": string,
  "profileSettings": {
    object (ProfileSettings)
  },
  "name": {
    "familyName": string,
    "givenName": string
  },
  "experienceInfo": {
    object (PlayerExperienceInfo)
  },
  "title": string,
  "friendStatus": enum (FriendStatus),
  "gamePlayerId": string
}
Felder
kind

string

Identifiziert eindeutig den Typ dieser Ressource. Der Wert ist immer der feste String games#player

playerId

string

ID des Spielers

displayName

string

Der Name, der für den Player angezeigt werden soll.

avatarImageUrl

string

Die Basis-URL für das Bild, das den Player repräsentiert.

bannerUrlPortrait

string

Die URL zum Bannerbild des Players im Hochformat

bannerUrlLandscape

string

Die URL zum Player-Bannerbild im Querformat.

originalPlayerId

string

Die Spieler-ID, die für diesen Spieler bei der ersten Anmeldung in dem betreffenden Spiel verwendet wurde. Dieses Feld wird nur bei Aufrufen von „player.get“ für den anfordernden Spieler ausgefüllt, wenn sich die Spieler-ID später geändert hat, und nur bei Clients, die die Neuzuordnung von Spieler-IDs unterstützen.

profileSettings

object (ProfileSettings)

Profileinstellungen des Spielers Mit dieser Einstellung legen Sie fest, ob das Profil des Spielers für andere Spieler sichtbar ist.

name

object

Objektdarstellung der einzelnen Komponenten des Spielernamens Bei einigen Spielern sind diese Felder möglicherweise nicht vorhanden.

name.familyName

string

Familienname dieses Spielers An einigen Stellen wird das auch als Nachname bezeichnet.

name.givenName

string

Name dieses Spielers In manchen Ländern wird er auch als Vorname bezeichnet.

experienceInfo

object (PlayerExperienceInfo)

Ein Objekt zur Darstellung von Play-Spiel-Informationen für den Spieler.

title

string

Der Titel des Spielers wurde für seine Spieleaktivitäten belohnt.

friendStatus

enum (FriendStatus)

Der Freundschaftsstatus des angegebenen Spielers, relativ zum Anfragenden. Diese Option ist nicht konfiguriert, wenn der Spieler seine Freundesliste nicht mit dem Spiel teilt.

gamePlayerId

string

Eindeutige Spieler-ID pro App.

ProfileSettings

Profileinstellungen

JSON-Darstellung
{
  "kind": string,
  "profileVisible": boolean,
  "friendsListVisibility": enum (FriendsListVisibility)
}
Felder
kind

string

Identifiziert eindeutig den Typ dieser Ressource. Der Wert ist immer der feste String games#profileSettings.

profileVisible

boolean

Gibt an, ob das Profil des Spielers für den derzeit angemeldeten Spieler sichtbar ist

friendsListVisibility

enum (FriendsListVisibility)

FriendsListVisibility

Gibt an, ob die Freundesliste des Spielers für dieses Spiel sichtbar oder angefordert werden kann Dieses Feld wird nur für den derzeit angemeldeten Spieler ausgefüllt.

Enums
VISIBLE Die Freundesliste ist derzeit für das Spiel sichtbar.
REQUEST_REQUIRED Der Entwickler hat keinen Zugriff auf die Freundesliste, kann aber die Android API aufrufen, um einen Dialog zur Einholung von Einwilligungen anzuzeigen.
UNAVAILABLE Die Freundesliste ist für diesen Nutzer derzeit nicht verfügbar und kann im Moment keinen Zugriff anfordern, da der Nutzer entweder dauerhaft abgelehnt hat oder die Freundesfunktion für ihn nicht verfügbar ist. In diesem Status schlagen alle Versuche, den Zugriff auf die Freundesliste anzufordern, fehl.

PlayerExperienceInfo

Eigene/Drittanbieter-Metadaten zum Erlebnis des Players.

JSON-Darstellung
{
  "kind": string,
  "currentExperiencePoints": string,
  "lastLevelUpTimestampMillis": string,
  "currentLevel": {
    object (PlayerLevel)
  },
  "nextLevel": {
    object (PlayerLevel)
  }
}
Felder
kind

string

Identifiziert eindeutig den Typ dieser Ressource. Der Wert ist immer der feste String games#playerExperienceInfo.

currentExperiencePoints

string (int64 format)

Die aktuelle Anzahl der Erfahrungspunkte für den Spieler.

lastLevelUpTimestampMillis

string (int64 format)

Der Zeitstempel, zu dem der Spieler das nächste Level erreicht hat, in Millis seit der Unix-Epoche UTC.

currentLevel

object (PlayerLevel)

Das aktuelle Level des Spielers.

nextLevel

object (PlayerLevel)

Das nächste Level des Spielers. Wenn die aktuelle Pegel die höchste Stufe ist, sollte diese mit der aktuellen Pegel übereinstimmen.

PlayerLevel

Eigene/Drittanbieter-Metadaten zur Ebene eines Nutzers.

JSON-Darstellung
{
  "kind": string,
  "level": integer,
  "minExperiencePoints": string,
  "maxExperiencePoints": string
}
Felder
kind

string

Identifiziert eindeutig den Typ dieser Ressource. Der Wert ist immer der feste String games#playerLevel.

level

integer

Die Ebene für den Nutzer.

minExperiencePoints

string (int64 format)

Die minimale Erfahrungspunkte für dieses Level.

maxExperiencePoints

string (int64 format)

Die maximalen Erfahrungspunkte für dieses Level.

FriendStatus

Definiert Freundschaftsbeziehungen zwischen Spielern.

Enums
NO_RELATIONSHIP Es besteht keine Beziehung zwischen den Spielern.
FRIEND Spieler und Anfragender sind Freunde.

Methoden

get

Ruft die Spielerressource mit der angegebenen ID ab.

getMultipleApplicationPlayerIds

Ruft die Spieler-IDs der Anwendung für den derzeit authentifizierten Player für alle Spiele vom selben Entwickler wie die aufrufende Anwendung ab.

getScopedPlayerIds

Ruft Spieler-IDs für den aktuell authentifizierten Nutzer ab.

list

Ruft die Sammlung der Spieler für den aktuell authentifizierten Nutzer ab.