Ponto final de notificação de sessão
| OBTER | https://s2s.singular.net/api/v1/launch |
Utilize o ponto final de notificação de sessão para comunicar todos os lançamentos de jogos (primeiras sessões, sessões repetidas) a este ponto final 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" da sua conta Singular, em "Ferramentas de desenvolvimento -> Integração SDK > Chaves SDK" | Obrigatório | nome_do_órgão_sh868sdjv |
| p | Plataforma do jogo, deve ter os seguintes valores suportados: pc, xbox, playstation, nintendo, metaquest |
Obrigatório Valores suportados apenas |
pc |
| i | Um valor de identificador de jogo exclusivo para o seu jogo. Utilize o mesmo valor se o mesmo jogo for distribuído em várias plataformas. |
Necessário Notação DNS inversa Sensível a maiúsculas e minúsculas |
com.singular.game |
| sdid |
ID de dispositivo Singular que a Singular utiliza para identificar instalações e actividades de jogo únicas para um utilizador. Este UUID deve ser gerado pelo jogo/servidor e recomenda-se que seja gerado no momento do primeiro lançamento do jogo (instalação). |
UUID (Versão 4) | 49c2d3a6-326e-4ec5-a16b-0a47e34ed953 |
| match_id |
Identificador que pode ser utilizado para atribuição, deve ser enviado no primeiro lançamento do jogo para o utilizador. Este valor deve corresponder ao "match_id" utilizado na implementação do Singular web SDK. Se o identificador for PII, deve ser submetido a um hash (SHA-256)
|
Opcional para atribuição determinística Se enviado, deve estar no primeiro lançamento do jogo após a instalação |
matchid_12345 |
| sistema operativo |
Sistema operativo / sistema de jogo São aceites valores personalizados, mas sugerem-se valores recomendados |
Necessário Valores personalizados suportados |
Plataforma = PC
Plataforma = XBox
Plataforma = Playstation
Plataforma = Nintendo
Plataforma = Meta Quest
|
| ve | Versão do sistema operativo | Opcional | 22H2 |
| av | Versão da aplicação ou compilação do jogo | Opcional | 1.1.5.581823a |
| ip |
IP do dispositivo no momento do evento de lançamento do jogo |
Obrigatório | 172.58.29.235 |
| use_ip | Extrai o campo IP do pedido HTTP. Se definir isto como verdadeiro, não forneça o parâmetro ip. |
Opcional booleano |
falso |
| install_source |
O nome da loja de jogos que distribuiu o jogo São suportados valores personalizados, mas são sugeridas recomendações |
Obrigatório |
steam epicgamestore microsoftstore gog humblestore xbox playstation nintendo auto-distribuído [personalizado]
|
| ua | Agente do utilizador do dispositivo | Opcional |
Mozilla/5.0 (Windows NT 10.0; Win64; x64) |
| propriedades_globais |
Pares de valores-chave que podem ser definidos e guardados para o utilizador. Os valores definidos devem ser mantidos em todas as chamadas subsequentes. O facto de não enviar um valor é considerado como uma anulação da definição do valor. |
Opcional São suportadas até 5 propriedades globais, cada uma com 200 caracteres Deve ser um objeto JSON codificado por URLE |
%7B%22key1%22%3A%22value1%22%2C% |
| data_sharing_options |
Passe este valor opcional para indicar o consentimento do utilizador final para partilhar informações. Se definido, este valor tem de ser mantido e passado em todos os pedidos /launch e /evt subsequentes para o utilizador. Ver Privacidade do utilizador do PC e da consola Passe "limit_data_sharing":false para indicar que o utilizador consentiu (optou por participar) na partilha das suas informações. Passe "limit_data_sharing":true se o utilizador recusar.
|
Opcional |
%7B%22limit_data_sharing%22%3Atrue%7D |
| instalar | Sinalizador de instalação. 'true' se a sessão foi a primeira após a instalação da aplicação. 'false' caso contrário. Necessário para recursos de rastreamento de reinstalação. |
Opcional Booleano |
verdadeiro |
| utime | Hora do lançamento do jogo em tempo UNIX. | Opcional | 1483228800 |
| umilisec | Hora de lançamento do jogo em milissegundos em tempo UNIX. | Opcional | 1483228800000 |
| custom_user_id |
ID do utilizador |
Opcional | 123456789abcd |
Ponto final de notificação de eventos
| OBTER | https://s2s.singular.net/api/v1/evt |
Utilize o ponto final de notificação de eventos para comunicar todos os eventos opcionais desejados no jogo a este ponto final o mais próximo possível do tempo real. A transmissão de eventos no jogo é altamente recomendada e é utilizada para análises, relatórios e encaminhamento para vários parceiros para otimização...
Parâmetros do evento
| Parâmetro | Descrição do evento | Restrições | Exemplo |
|---|---|---|---|
| a | A chave "SDK" da sua conta Singular, em "Ferramentas de desenvolvimento -> Integração SDK > Chaves SDK" | Obrigatório | nome_do_órgão_sh868sdjv |
| p | Plataforma do jogo, deve ter os seguintes valores suportados: pc, xbox, playstation, nintendo, metaquest |
Obrigatório Valores suportados apenas |
pc |
| i | Um valor de identificador de jogo exclusivo para o seu jogo. Utilize o mesmo valor se o mesmo jogo for distribuído em várias plataformas. |
Necessário Notação DNS inversa Sensível a maiúsculas e minúsculas |
com.singular.app |
| sdid |
ID de dispositivo Singular que a Singular utiliza para identificar instalações e actividades de jogo únicas para um utilizador. Este UUID deve ser gerado pelo jogo/servidor e recomenda-se que seja gerado no momento do primeiro lançamento do jogo (instalação). |
UUID | 49c2d3a6-326e-4ec5-a16b-0a47e34ed953 |
| n |
O nome do evento do jogo. É altamente recomendável usar a convenção de nomenclatura de eventos padrão do Singular. |
Necessário | sng_achievement_unlocked |
| e |
Atributos de evento personalizados que fornecem informações ricas sobre o evento, no formato JSON. É altamente recomendável usar a convenção de nomenclatura de atributos de eventos padrão da Singular. |
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 se trata de um evento de receitas. Pode omitir esta informação se o nome do evento for "__iap__" ou se for fornecido um "amt" diferente de zero. |
Obrigatório para eventos de receitas |
true |
| amt |
Se for um evento de receitas,o montante em moeda. Este parâmetro deve ser utilizado em conjunto com o parâmetro "cur". |
Obrigatório para os eventos de receitas |
2.51 |
| cur |
Se se tratar de um facto gerador de receitas, o código ISO-4217 de três letras da moeda. Deve ser utilizado em conjunto com o parâmetro "amt". |
Obrigatório para os eventos de receitas |
EUR |
| os |
Sistema operativo / sistema de jogo São aceites valores personalizados, mas sugerem-se valores recomendados |
Necessário Valores personalizados suportados |
Plataforma = PC
Plataforma = XBox
Plataforma = Playstation
Plataforma = Nintendo
Plataforma = Meta Quest
|
| ve | Versão do sistema operativo | Opcional | 22H2 |
| av | Versão da aplicação ou compilação do jogo | Opcional | 1.1.5.581823a |
| ip |
IP do dispositivo no momento do evento no jogo |
Obrigatório | 172.58.29.235 |
| use_ip | Extrai o campo IP do pedido HTTP. Se definir esta opção como verdadeira, não forneça o parâmetro ip. |
Opcional booleano |
falso |
| install_source |
O nome da loja de jogos que distribuiu o jogo São suportados valores personalizados, mas são sugeridas recomendações |
Obrigatório |
steam epicgamestore microsoftstore gog humblestore xbox playstation nintendo auto-distribuído [personalizado]
|
| ua | Agente do utilizador do dispositivo | Opcional |
Mozilla/5.0 (Windows NT 10.0; Win64; x64) |
| propriedades_globais |
Pares de valores-chave que podem ser definidos e guardados para o utilizador. Os valores definidos devem ser mantidos em todas as chamadas subsequentes. O facto de não enviar um valor é considerado como uma anulação da definição do valor. |
Opcional São suportadas até 5 propriedades globais, cada uma com 200 caracteres Deve ser um objeto JSON codificado por URLE |
%7B%22key1%22%3A%22value1%22%2C% |
| data_sharing_options
|
Passe este valor opcional para indicar o consentimento do utilizador final para partilhar informações. Se definido, este valor deve ser mantido e passado em todos os pedidos /launch e /evt subsequentes para o utilizador. Consulte Privacidade do utilizador de PC e consola Passe "limit_data_sharing":false para indicar que o utilizador consentiu (optou por participar) na partilha das suas informações. Passe "limit_data_sharing":true se o utilizador recusar. |
Opcional |
%7B%22limit_data_sharing%22%3Atrue%7D |
| utime | Hora do evento no jogo em tempo UNIX. | Opcional | 1483228800 |
| umilisec | Tempo do evento no jogo em milissegundos no tempo UNIX. | Opcional | 1483228800000 |
| custom_user_id |
ID do utilizador |
Opcional | 123456789abcd |