Ponto de extremidade de notificação de sessão
| GET | https://s2s.singular.net/api/v1/launch |
Use o endpoint de notificação de sessão para relatar todos os lançamentos de jogos (primeiras sessões repetidas) para esse endpoint o mais próximo possível do tempo real. O primeiro lançamento de jogo recebido pela Singular para uma instalação identificada pelo Singular Device ID é usado para atribuição.
Parâmetros de sessão
| Parâmetro | Descrição da sessão | Restrições | Exemplo |
|---|---|---|---|
| a | A chave "SDK" de sua conta do Singular, em "Developer Tools -> SDK Integration > SDK Keys" | Necessário | your_org_name_sh868sdjv |
| p | Plataforma de jogo, deve estar de acordo com os valores suportados: pc, xbox, playstation, nintendo, metaquest |
Necessário Somente valores suportados |
pc |
| i | Um valor de identificador de jogo exclusivo para seu jogo. Use o mesmo valor se o mesmo jogo for distribuído em várias plataformas. |
Necessário Notação de DNS reverso Sensível a maiúsculas e minúsculas |
com.singular.game |
| sdid |
ID de dispositivo exclusiva que a Singular usa para identificar as instalações e atividades de jogos exclusivas de um usuário. Essa UUID deve ser gerada pelo jogo/servidor e recomenda-se que seja gerada no momento da primeira inicialização (instalação) do jogo. O identificador deve persistir durante toda a vida útil da instalação do aplicativo. |
UUID (Version 4) | 49c2d3a6-326e-4ec5-a16b-0a47e34ed953 |
| match_id |
Um identificador exclusivo que possa ser usado para atribuição deve ser enviado na primeira inicialização do jogo. Esse valor deve corresponder ao "match_id" usado na implementação do Singular web SDK.
|
Opcional para atribuição determinística Se enviado, deve estar na primeira inicialização do jogo após a instalação |
matchid_12345 |
| os |
Sistema operacional / Sistema de jogo Valores personalizados são aceitos, mas os valores recomendados são sugeridos |
Necessário Valores personalizados suportados |
Platform = PC
Platform = XBox
Platform = Playstation
Platform = Nintendo
Platform = Meta Quest
|
| ve | Versão do sistema operacional | Opcional | 22H2 |
| av | A versão do aplicativo ou a versão do jogo | Opcional | 1.1.5.581823a |
| ip |
O endereço IP do dispositivo no momento do evento de lançamento do jogo |
Necessário | 172.58.29.235 |
| use_ip | Extrai o campo IP da solicitação HTTP. Se você definir isso como true, não forneça o parâmetro ip. |
Opcional Boolean |
false |
| install_source |
O nome da loja de jogos que distribuiu o jogo Valores personalizados são aceitos, mas sugerimos recomendações |
Necessário |
steam epicgamestore microsoftstore gog humblestore xbox playstation nintendo selfdistributed [custom]
|
| ua | Agente do usuário do dispositivo | Opcional |
Mozilla/5.0 (Windows NT 10.0; Win64; x64) |
| global_properties |
Pares de valores-chave que podem ser definidos e salvos para o usuário. Os valores definidos devem ser mantidos em todas as chamadas subsequentes. O não envio de um valor é considerado uma redefinição de valor. |
Opcional Há suporte para até 5 propriedades globais, cada uma com 200 caracteres. Deve ser um objeto JSON codificado por URL |
%7B%22key1%22%3A%22value1%22%2C% |
| install | Sinalizador de instalação. 'true' se a sessão foi a primeira depois que o aplicativo foi instalado. Caso contrário, "false". Necessário para os recursos de rastreamento Reinstall. |
Opcional Boolean |
true |
| utime | Hora de início do jogo no horário UNIX. | Opcional | 1483228800 |
| umilisec | Tempo de inicialização do jogo em milissegundos Hora UNIX. | Opcional | 1483228800000 |
| custom_user_id |
ID do usuário |
Opcional | 123456789abcd |
Ponto de extremidade de notificação de evento
| GET | https://s2s.singular.net/api/v1/evt |
Use o endpoint de notificação de evento para relatar todos os eventos opcionais desejados no jogo a esse endpoint o mais próximo possível do tempo real. A transmissão de eventos no jogo é altamente recomendada e é usada para análises, relatórios e encaminhamento a vários parceiros para otimização.
Parâmetros do evento
| Parâmetro | Descrição | Restrições | Exemplo |
|---|---|---|---|
| a | A chave "SDK" de sua conta do Singular, em "Developer Tools -> SDK Integration > SDK Keys" | Necessário | your_org_name_sh868sdjv |
| p | Plataforma de jogo, deve estar de acordo com os valores suportados: pc, xbox, playstation, nintendo, metaquest |
Necessário Somente valores suportados |
pc |
| i | Um valor de identificador de jogo exclusivo para seu jogo. Use o mesmo valor se o mesmo jogo for distribuído em várias plataformas. |
Necessário Notação de DNS reverso Sensível a maiúsculas e minúsculas |
com.singular.app |
| sdid |
ID de dispositivo exclusiva que a Singular usa para identificar as instalações e atividades de jogos exclusivas de um usuário. Essa UUID deve ser gerada pelo jogo/servidor e recomenda-se que seja gerada no momento da primeira inicialização (instalação) do jogo. O identificador deve persistir durante toda a vida útil da instalação do aplicativo. |
UUID | 49c2d3a6-326e-4ec5-a16b-0a47e34ed953 |
| n |
O nome do evento no jogo. É altamente recomendável usar a convenção de nomenclatura de eventos padrão da Singular. |
Necessário | sng_achievement_unlocked |
| e |
Atributos de eventos personalizados que fornecem informações detalhadas sobre o evento, no formato JSON. |
Opcional JSON |
%7B%22sng_attr_content_id%22%3A5581%2C sng_attr_content%22%3A%22XBox%22%2C%22 sng_attr_content_type%22%3A%22electronics%22%7D |
| is_revenue_event |
Se é um evento de receita. Você pode omitir isso se o nome do evento for "__iap__" ou se for fornecido um "amt" diferente de zero. |
Necessário para eventos de receita |
true |
| amt |
Se for um evento de receita, o valor da moeda. Isso deve ser usado em conjunto com o parâmetro "cur". |
Necessário para eventos de receita |
2.51 |
| cur |
Se for um evento de receita, o código de moeda de três letras ISO 4217. Isso deve ser usado em conjunto com o parâmetro "amt". |
Necessário para eventos de receita |
EUR |
| os |
Sistema operacional / Sistema de jogo Valores personalizados são aceitos, mas os valores recomendados são sugeridos |
Necessário Custom Values supported |
Platform = PC
Platform = XBox
Platform = Playstation
Platform = Nintendo
Platform = Meta Quest
|
| ve | Versão do sistema operacional | Opcional | 22H2 |
| av | A versão do aplicativo ou a versão do jogo | Opcional | 1.1.5.581823a |
| ip |
O endereço IP do dispositivo no momento do evento de lançamento do jogo |
Necessário | 172.58.29.235 |
| use_ip | Extrai o campo IP da solicitação HTTP. Se você definir isso como true, não forneça o parâmetro ip. |
Opcional Boolean |
false |
| install_source |
O nome da loja de jogos que distribuiu o jogo Valores personalizados são aceitos, mas sugerimos recomendações |
Necessário |
steam epicgamestore microsoftstore gog humblestore xbox playstation nintendo selfdistributed [custom]
|
| ua | Agente do usuário do dispositivo | Opcional |
Mozilla/5.0 (Windows NT 10.0; Win64; x64) |
| global_properties |
Pares de valores-chave que podem ser definidos e salvos para o usuário. Os valores definidos devem ser mantidos em todas as chamadas subsequentes. O não envio de um valor é considerado uma redefinição de valor. |
Opcional Há suporte para até 5 propriedades globais, cada uma com 200 caracteres. Deve ser um objeto JSON codificado por URL |
%7B%22key1%22%3A%22value1%22%2C% |
| utime | Hora do evento no jogo em horário UNIX. | Opcional | 1483228800 |
| umilisec | Hora do evento no jogo, em milissegundos, hora UNIX. | Opcional | 1483228800000 |
| custom_user_id |
ID do usuário |
Opcional | 123456789abcd |