Google Play Game Services . players

close()

Close httplib2 connections.

get(playerId, language=None, playerIdConsistencyToken=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.
  playerIdConsistencyToken: string, Consistency token of the player id. The call returns a 'not found' result when the token is present and invalid. Empty value is ignored. See also GlobalPlayerIdConsistencyTokenProto
  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.
  "avatarImageUrl": "A String", # The base URL for the image that represents the player.
  "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
  "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
  "displayName": "A String", # The name to display for the player.
  "experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
    "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.
      "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
      "level": 42, # The level for the user.
      "maxExperiencePoints": "A String", # The maximum experience points for this level.
      "minExperiencePoints": "A String", # The minimum experience points for this level.
    },
    "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
    "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
    "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.
      "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
      "level": 42, # The level for the user.
      "maxExperiencePoints": "A String", # The maximum experience points for this level.
      "minExperiencePoints": "A String", # The minimum experience points for this level.
    },
  },
  "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.
  "gamePlayerId": "A String", # Per-application unique player identifier.
  "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
  "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.
  },
  "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.
  "playerId": "A String", # The ID of the player.
  "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
    "friendsListVisibility": "A String",
    "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
    "profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player.
  },
  "title": "A String", # The player's title rewarded for their game activities.
}

getMultipleApplicationPlayerIds(applicationIds=None, x__xgafv=None)

Get the application player ids for the currently authenticated player across all requested games by the same developer as the calling application. This will only return ids for players that actually have an id (scoped or otherwise) with that game.

Args:
  applicationIds: string, Required. The application IDs from the Google Play developer console for the games to return scoped ids for. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for GetMultipleApplicationPlayerIds rpc.
  "playerIds": [ # Output only. The requested applications along with the scoped ids for tha player, if that player has an id for the application. If not, the application is not included in the response.
    { # Primary scoped player identifier for an application.
      "applicationId": "A String", # The application that this player identifier is for.
      "playerId": "A String", # The player identifier for the application.
    },
  ],
}

getScopedPlayerIds(x__xgafv=None)

Retrieves scoped player identifiers for currently authenticated user.

Args:
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Scoped player identifiers.
  "developerPlayerKey": "A String", # Identifier of the player across all games of the given developer. Every player has the same developer_player_key in all games of one developer. Developer player key changes for the game if the game is transferred to another developer. Note that game_player_id will stay unchanged.
  "gamePlayerId": "A String", # Game-scoped player identifier. This is the same id that is returned in GetPlayer game_player_id field.
}

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

Get the collection of players for the currently authenticated user.

Args:
  collection: string, Collection of players being retrieved (required)
    Allowed values
      CONNECTED - Retrieve a list of players that are also playing this game in reverse chronological order.
      VISIBLE - Retrieve a list of players in the user's social graph that are visible to this game.
      FRIENDS_ALL - Retrieve a list of players who are friends of the user in alphabetical order.
  language: string, The preferred language to use for strings returned by this method.
  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`.
  pageToken: string, The token returned by the previous request.
  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.
  "items": [ # The players.
    { # A Player resource.
      "avatarImageUrl": "A String", # The base URL for the image that represents the player.
      "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.
      "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.
      "displayName": "A String", # The name to display for the player.
      "experienceInfo": { # 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player.
        "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.
          "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
          "level": 42, # The level for the user.
          "maxExperiencePoints": "A String", # The maximum experience points for this level.
          "minExperiencePoints": "A String", # The minimum experience points for this level.
        },
        "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
        "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.
        "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.
          "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
          "level": 42, # The level for the user.
          "maxExperiencePoints": "A String", # The maximum experience points for this level.
          "minExperiencePoints": "A String", # The minimum experience points for this level.
        },
      },
      "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.
      "gamePlayerId": "A String", # Per-application unique player identifier.
      "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
      "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.
      },
      "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.
      "playerId": "A String", # The ID of the player.
      "profileSettings": { # Profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players.
        "friendsListVisibility": "A String",
        "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
        "profileVisible": True or False, # Whether the player's profile is visible to the currently signed in player.
      },
      "title": "A String", # The player's title rewarded for their game activities.
    },
  ],
  "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerListResponse`.
  "nextPageToken": "A String", # Token corresponding to the next page of results.
}

list_next()

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.