Descrição das APIs do medidor de leituras de perfil

​

APIs de administrador

• CheckLimitedEditionItemAvailability Verifica a contagem global do item de edição limitada.
• GetAllSegments Recupera uma matriz de definições de segmentos de jogadores. Os resultados podem ser usados em chamadas de API subsequentes, como GetPlayersInSegment, que exige uma Segment ID. Embora os nomes dos segmentos possam mudar, a ID desse segmento não muda.
• ExportMasterPlayerData Exporta todos os dados associados de uma conta de jogador mestre.
• GetCatalogItems Recupera a versão especificada do catálogo de bens virtuais do título, incluindo todas as propriedades definidas.
• GetContentList Lista todo o conteúdo do título e obtém estatísticas, como o tamanho.
• GetDataReport Recupera uma URL de download do relatório solicitado.
• GetPlayerSegments Lista todos os segmentos aos quais um jogador pertence neste momento.
• GetPlayerTags Obtém todas as marcas com um determinado Namespace (opcional) de um perfil de jogador.
• GetPolicy Obtém a política solicitada.
• GetPublisherData Recupera o repositório de chave-valor de configurações personalizadas do publicador.
• GetRandomResultTables Recupera a configuração da tabela de drops aleatórios do título.
• GetStoreItems Recupera o conjunto de itens definidos para a loja especificada, incluindo todos os preços definidos.
• GetTitleData Recupera o repositório de chave-valor de configurações personalizadas do título que podem ser lidas pelo cliente.
• [GetUserAccountInfo](Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier) Recupera os detalhes relevantes de um usuário especificado, com base na correspondência com um identificador exclusivo fornecido.
• GetUserBans Obtém todos os banimentos de um usuário.
• GetUserData Recupera os dados personalizados específicos do título do usuário que podem ser lidos e gravados pelo cliente.
• GetUserInternalData Recupera os dados personalizados específicos do título do usuário, que não podem ser acessados pelo cliente.
• GetUserInventory Recupera o inventário atual de bens virtuais do usuário especificado
• GetUserPublisherData Recupera os dados personalizados específicos do publicador do usuário que podem ser lidos e gravados pelo cliente.
• GetUserPublisherInternalData Recupera os dados personalizados específicos do publicador do usuário que não podem ser acessados pelo cliente.
• GetUserPublisherReadOnlyData Recupera os dados personalizados específicos do publicador do usuário que só podem ser lidos pelo cliente.
• GetUserReadOnlyData Recupera os dados personalizados específicos do título do usuário que só podem ser lidos pelo cliente.
• ListVirtualCurrencyTypes Retorna a lista de todas as moedas virtuais definidas para o título
• GetPlayerIdFromAuthToken Obtém a ID de um jogador a partir de um token de autenticação.
• GetPlayersInSegment Permite paginar todos os jogadores de um determinado segmento. Esta API cria um instantâneo de todos os perfis de jogador que correspondem à definição do segmento no momento de sua criação e permanece ativo durante o Total Seconds to Live, renovando seu tempo de vida a cada uso subsequente do Continuation Token. Os perfis que mudarem durante a paginação não serão refletidos nos resultados. No momento, os segmentos de teste A/B não têm suporte nesta operação.
• GetExperiments Obtém os detalhes de todos os experimentos de um título.
• GetLatestScorecard Obtém o scorecard mais recente do experimento do título.
• GetTreatmentAssignment Obtém as atribuições de tratamento de um jogador para cada experimento em execução no título

​

APIs de cliente

• GetAllUsersCharacters Lista todos os personagens que pertencem a um usuário específico. Os CharacterIds não são globalmente exclusivos; o characterId deve ser avaliado com o PlayFabId pai para garantir a exclusividade.
• GetCatalogItems Recupera a versão especificada do catálogo de bens virtuais do título, incluindo todas as propriedades definidas.
• GetCharacterData Recupera os dados personalizados específicos do título do personagem que podem ser lidos e gravados pelo cliente.
• GetCharacterInventory Recupera o inventário atual de bens virtuais do personagem especificado.
• GetCharacterLeaderboard Recupera uma lista classificada de personagens para a estatística fornecida, começando no ponto indicado do placar.
• GetCharacterReadOnlyData Recupera os dados personalizados específicos do título do personagem que só podem ser lidos pelo cliente.
• GetCharacterStatistics Recupera os detalhes de todas as estatísticas específicas do título do usuário.
• GetFriendLeaderboard Recupera uma lista classificada de amigos do jogador atual para a estatística fornecida, começando no ponto indicado do placar.
• GetFriendLeaderboardAroundPlayer Recupera uma lista classificada de amigos do jogador atual para a estatística fornecida, centralizada no usuário do PlayFab solicitado. Se PlayFabId estiver vazio ou nulo, retornará o usuário conectado no momento.
• GetFriendsList Recupera a lista de amigos atual do usuário local, restrita aos usuários que têm contas do PlayFab. Os amigos de contas vinculadas (Facebook, Steam) também são incluídos. Opcionalmente, você pode excluir os amigos de alguns serviços vinculados.
• GetLeaderboard Recupera uma lista classificada de usuários para a estatística fornecida, começando no ponto indicado do placar.
• GetLeaderboardAroundCharacter Recupera uma lista classificada de personagens para a estatística fornecida, centralizada na Character ID solicitada.
• GetLeaderboardAroundPlayer Recupera uma lista classificada de usuários para a estatística fornecida, centralizada no jogador solicitado. Se PlayFabId estiver vazio ou nulo, retornará o usuário conectado no momento.
• GetLeaderboardForUserCharacters Recupera uma lista de todos os personagens do usuário para a estatística fornecida.
• GetPaymentToken Para fluxos de pagamento em que o provedor exige que o PlayFab (o responsável pelo atendimento) inicie a transação, mas o cliente conclui o restante do fluxo. No caso da Xsolla, o token retornado aqui será passado para a Xsolla pelo cliente para criar um carrinho. Consulte GetPurchase periodicamente usando o OrderId retornado depois de concluir o pagamento.
• GetPlayerProfile Recupera o perfil do jogador.
• GetPlayerSegments Lista todos os segmentos aos quais um jogador pertence neste momento.
• GetPlayerStatistics Recupera as estatísticas indicadas (a versão atual e os valores de todas as estatísticas, se nenhuma for especificada) do jogador local.
• GetPlayerStatisticVersions Recupera as informações sobre as versões disponíveis da estatística especificada.
• GetPlayerTags Obtém todas as marcas com um determinado Namespace (opcional) de um perfil de jogador.
• GetPlayerTrades Obtém todas as trocas que o jogador abriu ou aceitou, opcionalmente filtradas pelo status da troca.
• GetPlayFabIDsFromFacebookIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do Facebook.
• GetPlayFabIDsFromFacebookInstantGamesIds Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do Facebook Instant Games.
• GetPlayFabIDsFromGameCenterIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do Game Center (chamados de Player Identifier no Game Center Programming Guide).
• GetPlayFabIDsFromGenericIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores de serviço genéricos. Um identificador genérico é o nome do serviço mais a ID do jogador específica do serviço, conforme especificado pelo título quando o identificador genérico foi adicionado à conta do jogador.
• GetPlayFabIDsFromGoogleIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do Google. Os identificadores do Google são as IDs das contas de usuário, disponíveis como id nas chamadas da API Google+ People.
• GetPlayFabIDsFromKongregateIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do Kongregate. Os identificadores do Kongregate são as IDs das contas de usuário, disponíveis como user_id nos métodos da API do Kongregate (por exemplo, https://docs.kongregate.com/docs/concepts-handling-guests).
• GetPlayFabIDsFromNintendoSwitchDeviceIds Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do Nintendo Switch.
• GetPlayFabIDsFromPSNAccountIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores da PlayStation™ Network.
• GetPlayFabIDsFromSteamIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do Steam. Os identificadores do Steam são as IDs de perfil das contas de usuário, disponíveis como SteamId nas chamadas da API Steamworks Community.
• GetPlayFabIDsFromTwitchIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores da Twitch. Os identificadores da Twitch são as IDs das contas de usuário, disponíveis como “_id” nos métodos da API da Twitch (ex.: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
• GetPlayFabIDsFromXboxLiveIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do XboxLive.
• GetPublisherData Recupera o repositório de chave-valor de configurações personalizadas do publicador.
• GetPurchase Recupera uma compra junto com seu status atual no PlayFab. Retorna os itens de inventário da compra que ainda estão ativos.
• GetSharedGroupData Recupera os dados armazenados em um objeto de grupo compartilhado e a lista de membros do grupo. Quem não é membro do grupo usa isso para recuperar os dados do grupo, incluindo a associação, mas não recebe os dados das chaves marcadas como privadas. Os grupos compartilhados foram projetados para compartilhar dados entre um número pequeno de jogadores. Para obter mais informações, consulte Usando dados de grupo compartilhado.
• GetStoreItems Recupera o conjunto de itens definidos para a loja especificada, incluindo todos os preços definidos.
• GetTitleData Recupera o repositório de chave-valor de configurações personalizadas do título
• GetAccountInfo Recupera os detalhes da conta do PlayFab do usuário.
• LoginWithAndroidDeviceID Conecta o usuário usando o identificador do dispositivo Android, retornando um identificador de sessão que pode ser usado posteriormente em chamadas de API que exigem um usuário autenticado.
• LoginWithCustomID Conecta o usuário usando um identificador exclusivo personalizado gerado pelo título, retornando um identificador de sessão que pode ser usado posteriormente em chamadas de API que exigem um usuário autenticado
• LoginWithEmailAddress Conecta o usuário à conta do PlayFab, retornando um identificador de sessão que pode ser usado posteriormente em chamadas de API que exigem um usuário autenticado. Ao contrário da maioria das outras chamadas de API de login, LoginWithEmailAddress não permite a criação de novas contas por meio de CreateAccountFlag. Endereços de email podem ser usados para criar contas por meio de RegisterPlayFabUser.
• LoginWithFacebook Conecta o usuário usando um token de acesso do Facebook, retornando um identificador de sessão que pode ser usado posteriormente em chamadas de API que exigem um usuário autenticado.
• LoginWithFacebookInstantGamesId Conecta o usuário usando uma ID do Facebook Instant Games, retornando um identificador de sessão que pode então ser usado em chamadas de API que exigem um usuário autenticado. Requer que o Facebook Instant Games esteja configurado.
• LoginWithGameCenter Conecta o usuário usando um identificador de jogador do iOS Game Center, retornando um identificador de sessão que pode ser usado posteriormente em chamadas de API que exigem um usuário autenticado.
• LoginWithGoogleAccount Conecta o usuário usando um identificador de jogador do iOS Game Center, retornando um identificador de sessão que pode ser usado posteriormente em chamadas de API que exigem um usuário autenticado.
• LoginWithIOSDeviceID Conecta o usuário usando as credenciais da conta do Google dele.
• LoginWithKongregate Conecta o usuário usando uma conta de jogador do Kongregate.
• LoginWithNintendoSwitchDeviceId Conecta o usuário usando uma ID de dispositivo Nintendo Switch, retornando um identificador de sessão que pode então ser usado em chamadas de API que exigem um usuário autenticado.
• LoginWithOpenIdConnect Faz login de um usuário usando um JWT Open ID Connect criado por um relacionamento existente entre um título e um provedor Open ID Connect.
• LoginWithPlayFab que exigem um usuário autenticado. Ao contrário da maioria das outras chamadas de API de login, LoginWithPlayFab não permite a criação de novas contas por meio de CreateAccountFlag. As credenciais de nome de usuário/senha podem ser usadas para criar contas por meio de RegisterPlayFabUser ou adicionadas a contas existentes usando AddUsernamePassword.
• LoginWithPSN Conecta o usuário à conta do PlayFab, retornando um identificador de sessão que pode então ser usado em chamadas de API que exigem um usuário autenticado. Ao contrário da maioria das outras chamadas de API de login, LoginWithPlayFab não permite a criação de novas contas por meio de CreateAccountFlag. As credenciais de nome de usuário/senha são usadas para criar contas por meio de RegisterPlayFabUser ou adicionadas a contas existentes usando AddUsernamePassword.
• LoginWithSteam Conecta o usuário usando um tíquete de autenticação do Steam, retornando um identificador de sessão que pode ser usado posteriormente em chamadas de API que exigem um usuário autenticado.
• LoginWithTwitch Conecta o usuário usando um token de acesso da Twitch.
• LoginWithXbox Conecta o usuário usando um token do XBOX Live, retornando um identificador de sessão que pode ser usado posteriormente em chamadas de API que exigem um usuário autenticado.
• GetPlayerCombinedInfo Recupera todos os diferentes tipos de informações do usuário.

​

APIs de dados

• GetObjects Recupera objetos do perfil de uma entidade.

​

APIs de grupos

• GetGroup Obtém informações sobre um grupo e suas funções.
• IsMember Verifica se uma entidade é membro de um grupo ou de uma função dentro do grupo.
• ListGroupApplications Lista todas as solicitações pendentes para ingressar em um grupo.
• ListGroupBlocks Lista todas as entidades impedidas de ingressar em um grupo.
• ListGroupInvitations Lista todos os convites pendentes de um grupo.
• ListGroupMembers Lista todos os membros de um grupo.
• ListMembership Lista todos os grupos e funções de uma entidade.
• ListMembershipOpportunities Lista todos os convites e solicitações de grupo pendentes de uma entidade.

​

APIs de perfil

• GetGlobalPolicy Obtém a política global de acesso do título.
• GetProfile Recupera o perfil da entidade.
• GetProfiles Recupera o perfil da entidade.
• GetTitlePlayersFromMasterPlayerAccountIds Recupera as contas de jogador do título associadas à conta de jogador mestre fornecida.

​

APIs de servidor

• EvaluateRandomResultTable Retorna o resultado da avaliação de uma Random Result Table: o ItemId do Catalog do jogo que teria sido adicionado ao inventário do jogador se a Random Result Table fosse adicionada por meio de um Bundle ou de uma chamada a UnlockContainer.
• GetAllSegments Recupera uma matriz de definições de segmentos de jogadores. Os resultados podem ser usados em chamadas de API subsequentes, como GetPlayersInSegment, que exige uma Segment ID. Embora os nomes dos segmentos possam mudar, a ID desse segmento não muda.
• GetAllUsersCharacters Lista todos os personagens que pertencem a um usuário específico. Os CharacterIds não são globalmente exclusivos; o characterId deve ser avaliado com o PlayFabId pai para garantir a exclusividade.
• GetCatalogItems Recupera a versão especificada do catálogo de bens virtuais do título, incluindo todas as propriedades definidas.
• GetCharacterData Recupera os dados personalizados específicos do título do usuário que podem ser lidos e gravados pelo cliente.
• GetCharacterInternalData Recupera os dados personalizados específicos do título do personagem do usuário que não podem ser acessados pelo cliente.
• GetCharacterInventory Recupera o inventário atual de bens virtuais do personagem especificado.
• GetCharacterReadOnlyData
• GetCharacterStatistics Recupera os detalhes de todas as estatísticas específicas do título do personagem específico.
• GetFriendLeaderboard Recupera uma lista classificada de amigos do jogador fornecido para a estatística fornecida, começando no ponto indicado do placar.
• GetFriendsList Recupera os amigos atuais do usuário com PlayFabId, restritos aos usuários que têm contas do PlayFab. Os amigos de contas vinculadas (Facebook, Steam) também são incluídos. Opcionalmente, você pode excluir os amigos de alguns serviços vinculados.
• GetLeaderboard Recupera uma lista classificada de usuários para a estatística fornecida, começando no ponto indicado do placar.
• GetLeaderboardAroundCharacter Recupera uma lista classificada de personagens para a estatística fornecida, centralizada no usuário solicitado.
• GetLeaderboardAroundUser Recupera uma lista classificada de personagens para a estatística fornecida, centralizada no usuário solicitado.
• GetLeaderboardForUserCharacters Recupera uma lista de todos os personagens do usuário para a estatística fornecida.
• GetPlayerCombinedInfo Retorna todas as informações solicitadas na resposta para o usuário. Observe que dados pessoais, como endereço de email e ID do Facebook, podem ser retornados. Todos os parâmetros têm false como padrão.
• GetPlayerProfile Recupera o perfil do jogador.
• GetPlayerSegments Lista todos os segmentos aos quais um jogador pertence neste momento.
• GetPlayersInSegment Permite paginar todos os jogadores de um determinado segmento. Esta API cria um instantâneo de todos os perfis de jogador que correspondem à definição do segmento no momento de sua criação e permanece ativo durante o Total Seconds to Live, renovando seu tempo de vida a cada uso subsequente do Continuation Token. Os perfis que mudam durante a paginação não são refletidos nos resultados. No momento, os segmentos de teste A/B não têm suporte nesta operação.
• GetPlayerStatistics Recupera a versão atual e os valores das estatísticas indicadas do jogador local.
• GetPlayerStatisticVersions Recupera as informações sobre as versões disponíveis da estatística especificada.
• GetPlayerTags Obtém todas as marcas com um determinado Namespace (opcional) de um perfil de jogador.
• GetPlayFabIDsFromFacebookIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do Facebook.
• GetPlayFabIDsFromFacebookInstantGamesIds Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do Facebook.
• GetPlayFabIDsFromGenericIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores de serviço genéricos. Um identificador genérico é o nome do serviço mais a ID do jogador específica do serviço, conforme especificado pelo título quando o identificador genérico foi adicionado à conta do jogador.
• GetPlayFabIDsFromNintendoSwitchDeviceIds Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores de dispositivo Nintendo Switch.
• GetPlayFabIDsFromPSNAccountIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores da PlayStation Network.
• GetPlayFabIDsFromSteamIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do Steam. Os identificadores do Steam são as IDs de perfil das contas de usuário, disponíveis como SteamId nas chamadas da API Steamworks Community.
• GetPlayFabIDsFromXboxLiveIDs Recupera os identificadores exclusivos do PlayFab para o conjunto fornecido de identificadores do XboxLive.
• GetPublisherData Recupera o repositório de chave-valor de configurações personalizadas do publicador.
• GetRandomResultTables Recupera as informações de configuração das tabelas de resultados aleatórios especificadas do título, incluindo todos os valores de ItemId e pesos.
• GetServerCustomIDsFromPlayFabIDs Recupera os identificadores de conta do PlayFab associados ao conjunto fornecido de identificadores personalizados de servidor.
• GetSharedGroupData Recupera os dados armazenados em um objeto de grupo compartilhado e a lista de membros do grupo. O servidor pode acessar todos os dados públicos e privados do grupo. Os grupos compartilhados foram projetados para compartilhar dados entre um número pequeno de jogadores. Para obter mais informações, consulte Usando dados de grupo compartilhado.
• GetStoreItems Recupera o conjunto de itens definidos para a loja especificada, incluindo todos os preços definidos, para o jogador especificado.
• GetTitleData Recupera o repositório de chave-valor de configurações personalizadas do título.
• GetTitleInternalData Recupera o repositório de chave-valor de configurações internas personalizadas do título.
• GetUserAccountInfo Recupera os detalhes relevantes de um usuário especificado.
• GetUserBans Obtém todos os banimentos de um usuário.
• GetUserData Recupera os dados personalizados específicos do título do usuário que podem ser lidos e gravados pelo cliente.
• GetUserInternalData Recupera os dados personalizados específicos do título do usuário que não podem ser acessados pelo cliente.
• GetUserInventory Recupera o inventário atual de bens virtuais do usuário especificado.
• GetUserPublisherData Recupera os dados personalizados específicos do publicador do usuário que podem ser lidos e gravados pelo cliente.
• GetUserPublisherInternalData Recupera os dados personalizados específicos do publicador do usuário que não podem ser acessados pelo cliente.
• GetUserPublisherReadOnlyData
• GetUserReadOnlyData Atualiza os dados personalizados específicos do título do usuário que só podem ser lidos pelo cliente.
• LoginWithServerCustomId Faz login com segurança de um cliente de jogo a partir de um back-end de servidor externo usando um identificador personalizado desse jogador. Server Custom ID e Client Custom ID são mutuamente exclusivos e não podem ser usados para recuperar a mesma conta de jogador.
• LoginWithXbox Conecta o usuário usando um token do XBOX Live de um back-end de servidor externo, retornando um identificador de sessão que pode ser usado posteriormente em chamadas de API que exigem um usuário autenticado.
• LoginWithXboxId Conecta o usuário usando uma XBOX ID e uma Sandbox ID, retornando um identificador de sessão que pode ser usado posteriormente em chamadas de API que exigem um usuário autenticado.