Google Play Game Services . players

Instance Methods

get(playerId, language=None, x__xgafv=None)

Retrieves the Player resource with the given ID. To retrieve the player

list(collection, language=None, pageToken=None, maxResults=None, x__xgafv=None)

Get the collection of players for the currently authenticated user.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(playerId, language=None, x__xgafv=None)
Retrieves the Player resource with the given ID.  To retrieve the player
for the currently authenticated user, set `playerId` to `me`.

Args:
  playerId: string, A player ID. A value of `me` may be used in place of the
authenticated player's ID. (required)
  language: string, The preferred language to use for strings returned by this method.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Player resource.
    "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
    "avatarImageUrl": "A String", # The base URL for the image that represents the player.
    "title": "A String", # The player's title rewarded for their game activities.
    "displayName": "A String", # The name to display for the player.
    "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile
        # is visible to other players.
      "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
          # string `games#profileSettings`.
      "friendsListVisibility": "A String",
      "profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player.
    },
    "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
        # string `games#player`
    "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is
        # unset if the player is not sharing their friends list with the game.
    "name": { # A representation of the individual components of the name.
      "familyName": "A String", # The family name of this player. In some places, this is known as the last
          # name.
      "givenName": "A String", # The given name of this player. In some places, this is known as the first
          # name.
    },
    "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
    "experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
      "nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level,
          # this should be same as the current level.
        "minExperiencePoints": "A String", # The minimum experience points for this level.
        "maxExperiencePoints": "A String", # The maximum experience points for this level.
        "level": 42, # The level for the user.
        "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
            # string `games#playerLevel`.
      },
      "currentExperiencePoints": "A String", # The current number of experience points for the player.
      "currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player.
        "minExperiencePoints": "A String", # The minimum experience points for this level.
        "maxExperiencePoints": "A String", # The maximum experience points for this level.
        "level": 42, # The level for the user.
        "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
            # string `games#playerLevel`.
      },
      "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch
          # UTC.
      "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
          # string `games#playerExperienceInfo`.
    },
    "playerId": "A String", # The ID of the player.
    "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into
        # the game in question. This is only populated for calls to player.get for
        # the requesting player, only if the player ID has subsequently changed, and
        # only to clients that support remapping player IDs.
  }
list(collection, language=None, pageToken=None, maxResults=None, x__xgafv=None)
Get the collection of players for the currently authenticated user.

Args:
  collection: string, Collection of players being retrieved (required)
  language: string, The preferred language to use for strings returned by this method.
  pageToken: string, The token returned by the previous request.
  maxResults: integer, The maximum number of player resources to return in the response, used for
paging. For any response, the actual number of player resources returned
may be less than the specified `maxResults`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A third party player list response.
    "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
        # string `games#playerListResponse`.
    "items": [ # The players.
      { # A Player resource.
        "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
        "avatarImageUrl": "A String", # The base URL for the image that represents the player.
        "title": "A String", # The player's title rewarded for their game activities.
        "displayName": "A String", # The name to display for the player.
        "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile
            # is visible to other players.
          "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
              # string `games#profileSettings`.
          "friendsListVisibility": "A String",
          "profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player.
        },
        "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
            # string `games#player`
        "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is
            # unset if the player is not sharing their friends list with the game.
        "name": { # A representation of the individual components of the name.
          "familyName": "A String", # The family name of this player. In some places, this is known as the last
              # name.
          "givenName": "A String", # The given name of this player. In some places, this is known as the first
              # name.
        },
        "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
        "experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
          "nextLevel": { # 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level,
              # this should be same as the current level.
            "minExperiencePoints": "A String", # The minimum experience points for this level.
            "maxExperiencePoints": "A String", # The maximum experience points for this level.
            "level": 42, # The level for the user.
            "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
                # string `games#playerLevel`.
          },
          "currentExperiencePoints": "A String", # The current number of experience points for the player.
          "currentLevel": { # 1P/3P metadata about a user's level. # The current level of the player.
            "minExperiencePoints": "A String", # The minimum experience points for this level.
            "maxExperiencePoints": "A String", # The maximum experience points for this level.
            "level": 42, # The level for the user.
            "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
                # string `games#playerLevel`.
          },
          "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch
              # UTC.
          "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
              # string `games#playerExperienceInfo`.
        },
        "playerId": "A String", # The ID of the player.
        "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into
            # the game in question. This is only populated for calls to player.get for
            # the requesting player, only if the player ID has subsequently changed, and
            # only to clients that support remapping player IDs.
      },
    ],
    "nextPageToken": "A String", # Token corresponding to the next page of results.
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.