REST Resource: players

Ressource: Spieler

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

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

playerId

string

ID des Players

displayName

string

Der für den Player anzuzeigende Name.

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 Bannerbild des Players im Querformat.

originalPlayerId

string

Die Spieler-ID, die für diesen Spieler bei seiner ersten Anmeldung im betreffenden Spiel verwendet wurde. Dieses Feld wird nur bei Aufrufen von player.get für den anfordernden Spieler ausgefüllt, nur dann, wenn sich die Spieler-ID anschließend geändert hat, und nur bei Clients, die die Neuzuordnung der Spieler-IDs unterstützen.

profileSettings

object (ProfileSettings)

Profileinstellungen des Spielers Legt fest, ob das Profil des Spielers für andere Spieler sichtbar ist.

name

object

Eine Objektdarstellung der einzelnen Komponenten des Spielernamens. Für einige Spieler sind diese Felder möglicherweise nicht vorhanden.

name.familyName

string

Familienname dieses Spielers An einigen Stellen wird dies als Nachname bezeichnet.

name.givenName

string

Der Vorname dieses Spielers. An manchen Stellen wird dies als Vorname bezeichnet.

experienceInfo

object (PlayerExperienceInfo)

Ein Objekt, das Informationen zum Spielerlebnis für den Spieler darstellt.

title

string

Der Titel des Spielers, der für seine Spielaktivitäten belohnt wird.

friendStatus

enum (FriendStatus)

Der Freundschaftsstatus des Spielers im Verhältnis zum Anfragenden. Diese Einstellung ist nicht festgelegt, wenn der Spieler seine Freundesliste nicht mit dem Spiel teilt.

gamePlayerId

string

Eindeutige Spielerkennung pro Anwendung.

ProfileSettings

Profileinstellungen

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

string

Kennzeichnet den Typ dieser Ressource eindeutig. 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 ist oder angefordert werden kann. Dieses Feld wird nur für den aktuell 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 momentan nicht verfügbar und es kann derzeit keine Zugriffsanfrage gestellt werden, weil der Nutzer entweder dauerhaft abgelehnt hat oder die Funktion "Freunde" für ihn nicht verfügbar ist. In diesem Status schlagen alle Versuche, Zugriff auf die Freundesliste anzufordern, fehl.

PlayerExperienceInfo

Selbst erhobene und Drittanbieter-Metadaten zur Erfahrung des Spielers.

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

string

Kennzeichnet den Typ dieser Ressource eindeutig. 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 für den Zeitpunkt, zu dem das Level des Players erreicht wurde, in Millisekunden seit der Unix-Epoche UTC.

currentLevel

object (PlayerLevel)

Der aktuelle Pegel des Players.

nextLevel

object (PlayerLevel)

Das nächste Level des Players. Wenn die aktuelle Ebene die höchste ist, muss sie mit der aktuellen Ebene übereinstimmen.

PlayerLevel

Selbst erhobene und Drittanbieter-Metadaten zur Ebene eines Nutzers.

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

string

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

level

integer

Das Level für den Nutzer.

minExperiencePoints

string (int64 format)

Die Mindestanzahl von Erfahrungspunkten für dieses Level.

maxExperiencePoints

string (int64 format)

Die maximalen Erfahrungspunkte für dieses Level.

FriendStatus

definiert Freundschaftsbeziehungen zwischen Spielern.

Enums
NO_RELATIONSHIP Es gibt keine Beziehung zwischen den Spielern.
FRIEND Spieler und Anforderer sind Freunde.

Methoden

get

Ruft die Player-Ressource mit der angegebenen ID ab.

getMultipleApplicationPlayerIds

Ruft die Spieler-IDs der Anwendung für den aktuell authentifizierten Spieler für alle angeforderten Spiele vom gleichen Entwickler wie die aufrufende Anwendung ab.

getScopedPlayerIds

Ruft die Spielerkennungen mit Bereichsbereich für den aktuell authentifizierten Nutzer ab.

list

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